org.apache.chemistry.opencmis.commons.spi

Interface VersioningService

All Known Subinterfaces:

CallContextAwareCmisService, CmisService, ProgressControlCmisService

All Known Implementing Classes:

AbstractBindingCmisServiceWrapper, AbstractCmisService, AbstractCmisServiceWrapper, CachedBindingCmisService, ConformanceCmisServiceWrapper, FilterCmisService, HttpSessionCmisService, LruCacheCmisService, SimpleForwardingCmisService, SimpleLoggingCmisServiceWrapper

public interface VersioningService

Versioning Service interface.

See the CMIS 1.0 and CMIS 1.1 specifications for details on the operations, parameters, exceptions and the domain model.

Method Summary

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.

Method Detail

checkOut

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

Create a private working copy of the document.

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

extension - extension data

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

cancelCheckOut

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

Reverses the effect of a check-out.

Parameters:

repositoryId - the identifier for the repository

objectId - the identifier for the PWC

extension - extension data

checkIn

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. The stream in contentStream is consumed but not closed by this method.

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

extension - extension data

getObjectOfLatestVersion

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.

Parameters:

repositoryId - the identifier for the repository

objectId - the identifier for the object

versionSeriesId - the version series ID

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

extension - extension data

Returns:

the document object

getPropertiesOfLatestVersion

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.

Parameters:

repositoryId - the identifier for the repository

objectId - the identifier for the object

versionSeriesId - the version series ID

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

extension - extension data

Returns:

the document properties

getAllVersions

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. Either the objectId or the versionSeriesId parameter must be set.

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)

extension - extension data

Returns:

the complete version history of the version series