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 Syndicator
public interface SyndicatorRepresents a WCM Syndicator. This interface allows users to enable, disable, update and monitoring a Syndicator. A Syndicator is retrieved from the SyndcationService.
Method Summary DocumentLibrary[] getLibraries(Workspace p_workspace)
Returns an array of document libraries which are currently being syndicated by this Syndicator.java.lang.String getName()
Returns the name of this syndicator.SyndicationStatus getStatus()
Returns the SyndicationStatus of this Syndicator.boolean isEnabled()
Returns true if this Syndicator is enabled, false if not.boolean rebuild()
Trigger a full rebuild of the Syndicator.void setEnabled(boolean enabled, Workspace p_workspace)
Set true to enable this Syndicator.boolean update()
Trigger an update of the Syndicator.
Method Detail getStatus
SyndicationStatus getStatus()
- Returns the SyndicationStatus of this Syndicator.
- Returns:
- SyndicationStatus of this Syndicator
- Since:
- 6.1
getLibraries
DocumentLibrary[] getLibraries(Workspace p_workspace)
- Returns an array of document libraries which are currently being syndicated by this Syndicator.
- Parameters:
- p_workspace - the workspace of the current user calling this method
- Returns:
- array of document libraries that are currently being syndicated
- 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 syndicator 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 Syndicator is enabled, false if not.
- Returns:
- true if this Syndicator is enabled, false if not.
- Since:
- 6.1
getName
java.lang.String getName()
- Returns the name of this syndicator.
- Returns:
- the name of the current syndicator
- Since:
- 6.1
rebuild
boolean rebuild() throws SyndicationNotEnabledException, SyndicationDeploymentException
- Trigger a full rebuild of the Syndicator. This will effectively send through all the items in the selected syndication libraries.
- Returns:
- true if the rebuild command was sent successfully and queued for syndication. This means that the request was made successfully, and there is no existing or outstanding updates for the current syndication pair. false if rebuild command failed. This will be because there is an existing or outstanding update on the current syndication/subscriber pair.
- Throws:
- SyndicationNotEnabledException - if the Subcriber/Syndicator isn't enabled
- SyndicationDeploymentException - if the Syndicator or Subscriber couldn't send the rebuild request
- Since:
- 6.1
update
boolean update() throws SyndicationNotEnabledException, SyndicationDeploymentException
- Trigger an update of the Syndicator. This will send only the updates which have happened between now and the last syndication run.
- Returns:
- true if the update command was sent successfully queued for syndication. This means that the request was made successfully, and there is no existing or outstanding updates for the current syndication pair. false if update command failed because there is an existing or outstanding update on the current syndication/subscriber pair.
- Throws:
- SyndicationNotEnabledException - if the Subcriber/Syndicator isn't enabled
- SyndicationDeploymentException - if the Syndicator or Subscriber couldn't 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