com.ibm.workplace.wcm.api
Interface Syndicator

All Superinterfaces:

Document, Item, Localized, WCMApiObject

public interface Syndicator
extends Document

Represents a WCM Syndicator. This interface allows users to enable, disable, update and monitoring a Syndicator. A Syndicator is retrieved from the SyndcationService.

Method Summary

DocumentIdIterator	getFailedItems() Retrieves all the failed items for this Syndicator.
DocumentLibrary[]	getLibraries(Workspace 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.
DocumentIdIterator	getPendingItems() Retrieves the items that are pending syndication for 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.
boolean	rebuild(com.ibm.workplace.wcm.api.RebuildType type) Trigger a rebuild of the Syndicator for the given type.
void	setEnabled(boolean enabled, Workspace workspace) Set true to enable this Syndicator.
boolean	update() Trigger an update of the Syndicator.

Methods inherited from interface com.ibm.workplace.wcm.api.Document

getAuthors, getCategoryIds, getContributorAccessMembers, getCreator, getDeleteAccessMembers, getDescription, getDescriptionTextProviderKey, getDescriptionTextProviderName, getEditAccessMembers, getEditorAccessMembers, getHistoryLog, getId, getInheritedContributorAccessMembers, getInheritedEditorAccessMembers, getInheritedManagerAccessMembers, getInheritedUserAccessMembers, getKeywords, getLastModifier, getLiveAccessMembers, getManagerAccessMembers, getMembersForAccess, getMembersForInheritedAccess, getOwnerLibrary, getOwners, getProject, getReadAccessMembers, getSourceWorkspace, getTitle, getTitleTextProviderKey, getTitleTextProviderName, getUserAccessMembers, getVersionCatalog, getVersionStrategy, hasDeleteAccess, hasDeleteAccess, hasEditAccess, hasEditAccess, hasLiveAccess, hasLiveAccess, hasProfile, hasProject, hasReadAccess, hasReadAccess, isContributorAccessInherited, isEditorAccessInherited, isInherited, isManagerAccessInherited, isNew, isPropagated, isUserAccessInherited, isWorkflowed

Methods inherited from interface com.ibm.workplace.wcm.api.Item

getCreationDate, getDescription, getIdentity, getModifiedDate, getTitle

Methods inherited from interface com.ibm.portal.Localized

getLocales

Method Detail

getStatus

SyndicationStatus getStatus()

Returns the SyndicationStatus of this Syndicator.

Returns:

SyndicationStatus of this Syndicator

Since:

6.1

getLibraries

DocumentLibrary[] getLibraries(Workspace workspace)

Returns an array of document libraries which are currently being syndicated by this Syndicator.

Parameters:

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 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

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.

Specified by:

getName in interface Item

Specified by:

getName in interface WCMApiObject

Returns:

the name of the current syndicator

Since:

6.1

rebuild

boolean rebuild()
                throws com.ibm.workplace.wcm.api.exceptions.SyndicationNotEnabledException,
                       com.ibm.workplace.wcm.api.exceptions.SyndicationDeploymentException

Trigger a full rebuild of the Syndicator. This will effectively send through all the items in the selected syndication libraries. This is equivalent to calling #rebuild(RebuildType.DEFAULT)

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:

com.ibm.workplace.wcm.api.exceptions.SyndicationNotEnabledException - if the Subcriber/Syndicator isn't enabled

com.ibm.workplace.wcm.api.exceptions.SyndicationDeploymentException - if the Syndicator or Subscriber couldn't send the rebuild request

Since:

6.1

rebuild

boolean rebuild(com.ibm.workplace.wcm.api.RebuildType type)
                throws com.ibm.workplace.wcm.api.exceptions.SyndicationNotEnabledException,
                       com.ibm.workplace.wcm.api.exceptions.SyndicationDeploymentException

Trigger a rebuild of the Syndicator for the given type.

Parameters:

type - The type of rebuild to perform RebuildType.DEFAULT is equivalent to how rebuild has always worked RebuildType.MIRROR goes an additional step forward by reverting changes on the subscriber including removing items.

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:

com.ibm.workplace.wcm.api.exceptions.SyndicationNotEnabledException - if the Subcriber/Syndicator isn't enabled

com.ibm.workplace.wcm.api.exceptions.SyndicationDeploymentException - if the Syndicator or Subscriber couldn't send the rebuild request

Since:

8.5 CF7

update

boolean update()
               throws com.ibm.workplace.wcm.api.exceptions.SyndicationNotEnabledException,
                      com.ibm.workplace.wcm.api.exceptions.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:

com.ibm.workplace.wcm.api.exceptions.SyndicationNotEnabledException - if the Subcriber/Syndicator isn't enabled

com.ibm.workplace.wcm.api.exceptions.SyndicationDeploymentException - if the Syndicator or Subscriber couldn't send the update request to the other machine

Since:

6.1

getPendingItems

DocumentIdIterator getPendingItems()

Retrieves the items that are pending syndication for this Syndicator.

This will be the items that have been updated since the last syndication run.

Returns:

DocumentIdIterator of the pending documents yet to be Syndicated for this Syndicator

Throws:

com.ibm.workplace.wcm.api.exceptions.SyndicationRuntimeException - if there is an error retrieving the pending items for this Syndicator.

Since:

8.0

getFailedItems

DocumentIdIterator getFailedItems()
                                  throws com.ibm.workplace.wcm.api.exceptions.SyndicationRuntimeException

Retrieves all the failed items for this Syndicator.

Returns:

DocumentIdIterator of all the failed documents for this Syndicator

Throws:

com.ibm.workplace.wcm.api.exceptions.SyndicationRuntimeException - if there is an error retrieving the failed items for this Syndicator.