Overview Package Class Tree Deprecated Index Help PREV CLASS NEXT CLASS FRAMES NO FRAMES SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
com.ibm.workplace.wcm.api
Interface Subscriber
public interface SubscriberRepresents a WCM Subscriber. This interface allows users to enable, disable, update and monitoring a Subscriber. A Syndicator is retrieved from the SyndcationService.
Method Summary java.lang.String getName()
Returns the name of this subscriber.SyndicationStatus getStatus()
Returns the SyndicationStatus of this Subscriber.boolean isEnabled()
Returns true if this Subscriber is enabled, false if not.void rebuild()
Trigger a full rebuild of the Subscriber.void setEnabled(boolean enabled, Workspace p_workspace)
Set true to enable this Syndicator.void update()
Trigger an update of the Subscriber.
Method Detail getStatus
SyndicationStatus getStatus()
- Returns the SyndicationStatus of this Subscriber.
- Returns:
- SyndicationStatus of this Subscriber
- Since:
- 6.1
setEnabled
void setEnabled(boolean enabled, Workspace p_workspace)
- Set true to enable this Syndicator. Otherwise false to disable this Syndicator. An enabled subscriber can trigger syndication events such as updates and rebuilds. Trying to send a update to a disabled syndicator will throw a SyndicationNotEnabledException.
- Parameters:
- enabled - true to enable this Syndicator.
- p_workspace - the workspace of the current user setting this flag.
- Since:
- 6.1
isEnabled
boolean isEnabled()
- Returns true if this Subscriber is enabled, false if not.
- Returns:
- true if this Subscriber is enabled, false if not.
- Since:
- 6.1
getName
java.lang.String getName()
- Returns the name of this subscriber.
- Returns:
- the name of the current subscriber
- Since:
- 6.1
rebuild
void rebuild() throws SyndicationNotEnabledException, SyndicationDeploymentException
- Trigger a full rebuild of the Subscriber. This will effective send all items in the selected syndication library across to the subscriber.
- Throws:
- SyndicationNotEnabledException - if the Subcriber/Syndicator is not enabled.
- SyndicationDeploymentException - if the Syndicator or Subscriber could not send the update request.
- Since:
- 6.1
update
void update() throws SyndicationNotEnabledException, SyndicationDeploymentException
- Trigger an update of the Subscriber. This will send only the updates which have happened between now and the last syndication run.
- Throws:
- SyndicationNotEnabledException - if the Subcriber/Syndicator is not enabled.
- SyndicationDeploymentException - if the Syndicator or Subscriber could not send the update request to the other machine.
- Since:
- 6.1
Overview Package Class Tree Deprecated Index Help PREV CLASS NEXT CLASS FRAMES NO FRAMES SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD