PREV CLASS
NEXT CLASS
com.ibm.workplace.wcm.api.extensions.syndication
Interface SyndicationSummary
-
public interface SyndicationSummary
The Syndication summary is provided as part of the SyndicatorCompleting and SubscriberCompleting extension points.
Summary provides information on the run that is completing
- Since:
- 8.5 CF5
|
Nested Class Summary
|
|
static class |
SyndicationSummary.Status
The status enum covers the various possible states the syndication run is in when the extension is called. |
|
Method Summary
|
|
java.util.List<com.ibm.workplace.wcm.api.extensions.syndication.Change> |
getChanges()
Retrieve the list of changes that were performed by syndication in this particular run. |
|
SyndicationSummary.Status |
getStatus()
Status reports whether syndication finished successfully, or due to errors
or if it was cancelled by an extension |
|
UpdateType |
getUpdateType()
Reports the type of update this syndication run was. |
getChanges
java.util.List<com.ibm.workplace.wcm.api.extensions.syndication.Change> getChanges()
- Retrieve the list of changes that were performed by syndication in this particular run.
- See Also:
- ChangeMapper} for information on one way to consume the changes.
getStatus
SyndicationSummary.Status getStatus()
- Status reports whether syndication finished successfully, or due to errors
or if it was cancelled by an extension
- Returns:
- the status the status of the syndication run
getUpdateType
UpdateType getUpdateType()
- Reports the type of update this syndication run was.
For now the syndication summary only reports the update type
for SubscriberCompleting extension point.
For SyndicatorCompleting this will always return UpdateType.UPDATE
- Returns:
- the type of syndication update this run was.
- Since:
- 8.5 CF7
PREV CLASS
NEXT CLASS