|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Subscriber
Represents a WCM Subscriber. This interface allows users to enable, disable,
update and monitoring a Subscriber.
A Subscriber is retrieved from the WcmSyndicationService
.
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 workspace)
Set true |
void |
update()
Trigger an update of the Subscriber . |
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 |
---|
SyndicationStatus getStatus()
SyndicationStatus
of this
Subscriber
.
SyndicationStatus
of this Subscriber
void setEnabled(boolean enabled, Workspace workspace)
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
.workspace
- the workspace
of the current user setting
this flag.- Since:
- 6.1
boolean isEnabled()
true
if this Subscriber
is enabled,
false
if not.
true
if this Subscriber
is enabled,
false
if not.java.lang.String getName()
getName
in interface Item
getName
in interface WCMApiObject
void rebuild() throws com.ibm.workplace.wcm.api.exceptions.SyndicationNotEnabledException, com.ibm.workplace.wcm.api.exceptions.SyndicationDeploymentException
Subscriber
.
This will effective send all items in the selected syndication library
across to the subscriber.
com.ibm.workplace.wcm.api.exceptions.SyndicationNotEnabledException
- if the Subcriber/Syndicator is
not enabled.
com.ibm.workplace.wcm.api.exceptions.SyndicationDeploymentException
- if the Syndicator or Subscriber
could not send the update request.void update() throws com.ibm.workplace.wcm.api.exceptions.SyndicationNotEnabledException, com.ibm.workplace.wcm.api.exceptions.SyndicationDeploymentException
Subscriber
.
This will send only the updates which have happened between now and the
last syndication run.
com.ibm.workplace.wcm.api.exceptions.SyndicationNotEnabledException
- if the Subcriber/Syndicator is
not enabled.
com.ibm.workplace.wcm.api.exceptions.SyndicationDeploymentException
- if the Syndicator or Subscriber
could not send the update request to the other machine.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |