org.apache.chemistry.opencmis.client.bindings.spi.local

Class VersioningServiceImpl

java.lang.Object

org.apache.chemistry.opencmis.client.bindings.spi.local.AbstractLocalService

org.apache.chemistry.opencmis.client.bindings.spi.local.VersioningServiceImpl

All Implemented Interfaces:

VersioningService

public class VersioningServiceImpl
extends AbstractLocalService
implements VersioningService

Constructor Summary

Constructors

Constructor and Description
VersioningServiceImpl(BindingSession session, CmisServiceFactory factory) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
void	cancelCheckOut(String repositoryId, String objectId, ExtensionsData extension) Reverses the effect of a check-out.
void	checkIn(String repositoryId, Holder<String> objectId, Boolean major, Properties properties, ContentStream contentStream, String checkinComment, List<String> policies, Acl addAces, Acl removeAces, ExtensionsData extension) Checks-in the private working copy (PWC) document.
void	checkOut(String repositoryId, Holder<String> objectId, ExtensionsData extension, Holder<Boolean> contentCopied) Create a private working copy of the document.
List<ObjectData>	getAllVersions(String repositoryId, String objectId, String versionSeriesId, String filter, Boolean includeAllowableActions, ExtensionsData extension) Returns the list of all document objects in the specified version series, sorted by the property "cmis:creationDate" descending.
ObjectData	getObjectOfLatestVersion(String repositoryId, String objectId, String versionSeriesId, Boolean major, String filter, Boolean includeAllowableActions, IncludeRelationships includeRelationships, String renditionFilter, Boolean includePolicyIds, Boolean includeAcl, ExtensionsData extension) Get the latest document object in the version series.
Properties	getPropertiesOfLatestVersion(String repositoryId, String objectId, String versionSeriesId, Boolean major, String filter, ExtensionsData extension) Get a subset of the properties for the latest document object in the version series.

Methods inherited from class org.apache.chemistry.opencmis.client.bindings.spi.local.AbstractLocalService

createCallContext, getService, getServiceFactory, getSession, setServiceFactory, setSession

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

VersioningServiceImpl

public VersioningServiceImpl(BindingSession session,
                     CmisServiceFactory factory)

Constructor.

Method Detail

cancelCheckOut

public void cancelCheckOut(String repositoryId,
                  String objectId,
                  ExtensionsData extension)

Description copied from interface: VersioningService

Reverses the effect of a check-out.

Specified by:

cancelCheckOut in interface VersioningService

Parameters:

repositoryId - the identifier for the repository

objectId - the identifier for the PWC

checkIn

public void checkIn(String repositoryId,
           Holder<String> objectId,
           Boolean major,
           Properties properties,
           ContentStream contentStream,
           String checkinComment,
           List<String> policies,
           Acl addAces,
           Acl removeAces,
           ExtensionsData extension)

Description copied from interface: VersioningService

Checks-in the private working copy (PWC) document. The stream in contentStream is consumed but not closed by this method.

Specified by:

checkIn in interface VersioningService

Parameters:

repositoryId - the identifier for the repository

objectId - input: the identifier for the PWC, output: the identifier for the newly created version document

major - indicator if the new version should become a major ( true) or minor (false) version

properties - (optional) the property values that must be applied to the newly created document object

contentStream - (optional) the content stream that must be stored for the newly created document object

checkinComment - (optional) a version comment

policies - (optional) a list of policy IDs that must be applied to the newly created document object

addAces - (optional) a list of ACEs that must be added to the newly created document object

removeAces - (optional) a list of ACEs that must be removed from the newly created document object

checkOut

public void checkOut(String repositoryId,
            Holder<String> objectId,
            ExtensionsData extension,
            Holder<Boolean> contentCopied)

Description copied from interface: VersioningService

Create a private working copy of the document.

Specified by:

checkOut in interface VersioningService

Parameters:

repositoryId - the identifier for the repository

objectId - input: the identifier for the document that should be checked out, output: the identifier for the newly created PWC

contentCopied - output: indicator if the content of the original document has been copied to the PWC

getAllVersions

public List<ObjectData> getAllVersions(String repositoryId,
                              String objectId,
                              String versionSeriesId,
                              String filter,
                              Boolean includeAllowableActions,
                              ExtensionsData extension)

Description copied from interface: VersioningService

Returns the list of all document objects in the specified version series, sorted by the property "cmis:creationDate" descending. Either the objectId or the versionSeriesId parameter must be set.

Specified by:

getAllVersions in interface VersioningService

Parameters:

repositoryId - the identifier for the repository

objectId - the identifier for the object

versionSeriesId - the identifier for the object

filter - (optional) a comma-separated list of query names that defines which properties must be returned by the repository (default is repository specific)

includeAllowableActions - (optional) if true, then the repository must return the allowable actions for the objects (default is false)

Returns:

the complete version history of the version series

getObjectOfLatestVersion

public ObjectData getObjectOfLatestVersion(String repositoryId,
                                  String objectId,
                                  String versionSeriesId,
                                  Boolean major,
                                  String filter,
                                  Boolean includeAllowableActions,
                                  IncludeRelationships includeRelationships,
                                  String renditionFilter,
                                  Boolean includePolicyIds,
                                  Boolean includeAcl,
                                  ExtensionsData extension)

Description copied from interface: VersioningService

Get the latest document object in the version series.

Specified by:

getObjectOfLatestVersion in interface VersioningService

Parameters:

repositoryId - the identifier for the repository

getPropertiesOfLatestVersion

public Properties getPropertiesOfLatestVersion(String repositoryId,
                                      String objectId,
                                      String versionSeriesId,
                                      Boolean major,
                                      String filter,
                                      ExtensionsData extension)

Description copied from interface: VersioningService

Get a subset of the properties for the latest document object in the version series.

Specified by:

getPropertiesOfLatestVersion in interface VersioningService

Parameters:

repositoryId - the identifier for the repository