org.apache.chemistry.opencmis.commons.spi
Interface VersioningService

All Known Subinterfaces:
CmisService
All Known Implementing Classes:
CmisServiceWrapper

public interface VersioningService

Versioning Service interface.

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


Method Summary
 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.


cancelCheckOut

void cancelCheckOut(String repositoryId,
                    String objectId,
                    ExtensionsData extension)
Reverses the effect of a check-out.


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.


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.


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.


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.



Copyright © 2009-2010 The Apache Software Foundation. All Rights Reserved.