org.alfresco.cmis

Interface CMISChangeLogService

All Known Implementing Classes:

CMISChangeLogServiceImpl

public interface CMISChangeLogService

Service for manipulating with Change Log Events by Change Log Tokens. Also this service exposes some methods for describing Auditing features

Method Summary

Methods

Modifier and Type	Method and Description
CMISCapabilityChanges	getCapability()
CMISChangeLog	getChangeLogEvents(java.lang.String changeLogToken, java.lang.Integer maxItems)
boolean	getChangesIncomplete()
java.util.List	getChangesOnTypeCapability()
java.lang.String	getLastChangeLogToken()
java.lang.String	getLastPageChangeLogToken(java.lang.String currentPageToken, java.lang.Integer maxItems) Assuming that currentPageToken begins a page of maxItems entries, gets the token at the start of the final page.
java.lang.String	getPreviousPageChangeLogToken(java.lang.String currentPageToken, java.lang.Integer maxItems) Gets the change log token maxItems entries before the given one

Method Detail

getChangeLogEvents

CMISChangeLog getChangeLogEvents(java.lang.String changeLogToken,
                               java.lang.Integer maxItems)
                                 throws CMISInvalidArgumentException

Parameters:

changeLogToken - - String value that represents some Change Log Token

maxItems - - Integer value that determines required amount of entries

Returns:

CMISChangeLog instance that describes entry mapped to specified Change Log Token

Throws:

CMISInvalidArgumentException

getLastChangeLogToken

java.lang.String getLastChangeLogToken()

Returns:

String value that represents Change Log Token which is currently actual

getPreviousPageChangeLogToken

java.lang.String getPreviousPageChangeLogToken(java.lang.String currentPageToken,
                                             java.lang.Integer maxItems)

Gets the change log token maxItems entries before the given one

Parameters:

currentPageToken - a change log token

maxItems - the number of entries to skip backwards

Returns:

the change log token maxItems entries before currentPageToken

getLastPageChangeLogToken

java.lang.String getLastPageChangeLogToken(java.lang.String currentPageToken,
                                         java.lang.Integer maxItems)

Assuming that currentPageToken begins a page of maxItems entries, gets the token at the start of the final page.

Parameters:

currentPageToken - a change log token

maxItems - the number of entries per page

Returns:

the change log token at the start of the final page

getCapability

CMISCapabilityChanges getCapability()

Returns:

CMISCapabilityChanges enum value that specifies currently configured Auditing feature mode

getChangesOnTypeCapability

java.util.List getChangesOnTypeCapability()

Returns:

List<CMISBaseObjectTypeIds> collection instance that contains configured value for Changes On Type capability

See Also:

CMISBaseObjectTypeIds

getChangesIncomplete

boolean getChangesIncomplete()

Returns:

always true