com.ibm.workplace.wcm.api.extensions.syndication
Interface ItemChange

All Superinterfaces:

Change

All Known Subinterfaces:

Added, Moved, Removed, Updated

public interface ItemChange
extends Change

Abstract Interface for all item related changes returned by SyndicationSummary.getChanges() as part of the SyndicatorCompleting and SubscriberCompleting extension points

The item captures changes the involving normal items, @see Added, Updated, Moved, Removed
For project and library items @see ProjectChange and LibraryChange

Method Summary

DocumentId<?>	getId()
java.lang.String	getLibraryName() The name of the library the item belongs to on which the change occurred.
java.lang.String	getNamePath() The name path of the item.
DocumentId<?>	getParentId() The parent id of the item that this occurred on.

Methods inherited from interface com.ibm.workplace.wcm.api.extensions.syndication.Change

getName, map

Method Detail

getId

DocumentId<?> getId()

Returns:

The id of the item that this change occurred on.

getLibraryName

java.lang.String getLibraryName()

The name of the library the item belongs to on which the change occurred. For moves this is the name of the library of the item after the move has occurred.

Returns:

the name of the library the item belongs to

getParentId

DocumentId<?> getParentId()

The parent id of the item that this occurred on. For moves this is the parent id of the item after the move has occurred.

Returns:

The parent id of the item that this occurred on

getNamePath

java.lang.String getNamePath()

The name path of the item. This is a case sensitive path similar to what is returned by Workspace#getPathById(DocumentId, true, true) For moves this is the name path of the item after the move has occurred.

Returns:

the name path of the item.