org.alfresco.repo.cmis.ws
Class DMVersioningServicePort

java.lang.Object
  extended by org.alfresco.repo.cmis.ws.DMAbstractServicePort
      extended by org.alfresco.repo.cmis.ws.DMVersioningServicePort
All Implemented Interfaces:
org.alfresco.repo.cmis.ws.VersioningServicePort

public class DMVersioningServicePort
extends DMAbstractServicePort
implements org.alfresco.repo.cmis.ws.VersioningServicePort

Port for versioning service.


Field Summary
 
Fields inherited from class org.alfresco.repo.cmis.ws.DMAbstractServicePort
authorityService, cmisAclService, cmisChangeLogService, cmisObjectFactory, cmisQueryService, cmisRenditionService, cmisService, descriptorService, fileFolderService, INCLUDE_RELATIONSHIPS_ENUM_MAPPING, nodeService, permissionService, propertiesUtil, searchService
 
Constructor Summary
DMVersioningServicePort()
           
 
Method Summary
 void cancelCheckOut(java.lang.String repositoryId, java.lang.String objectId, javax.xml.ws.Holder extension)
          Reverses the effect of a check-out.
 void checkIn(java.lang.String repositoryId, javax.xml.ws.Holder objectId, java.lang.Boolean major, org.alfresco.repo.cmis.ws.CmisPropertiesType properties, org.alfresco.repo.cmis.ws.CmisContentStreamType contentStream, java.lang.String checkinComment, java.util.List policies, org.alfresco.repo.cmis.ws.CmisAccessControlListType addACEs, org.alfresco.repo.cmis.ws.CmisAccessControlListType removeACEs, javax.xml.ws.Holder extension)
          Makes the private working copy the current version of the document.
 void checkOut(java.lang.String repositoryId, javax.xml.ws.Holder objectId, javax.xml.ws.Holder extension, javax.xml.ws.Holder contentCopied)
          Create a private working copy of the object, copies the metadata and optionally content.
 java.util.List getAllVersions(java.lang.String repositoryId, java.lang.String objectId, java.lang.String filter, java.lang.Boolean includeAllowableActions, org.alfresco.repo.cmis.ws.CmisExtensionType extension)
          Gets the list of all document versions for the specified version series.
 org.alfresco.repo.cmis.ws.CmisObjectType getObjectOfLatestVersion(java.lang.String repositoryId, java.lang.String objectId, java.lang.Boolean major, java.lang.String filter, java.lang.Boolean includeAllowableActions, org.alfresco.repo.cmis.ws.EnumIncludeRelationships includeRelationships, java.lang.String renditionFilter, java.lang.Boolean includePolicyIds, java.lang.Boolean includeACL, org.alfresco.repo.cmis.ws.CmisExtensionType extension)
           
 org.alfresco.repo.cmis.ws.CmisPropertiesType getPropertiesOfLatestVersion(java.lang.String repositoryId, java.lang.String objectId, java.lang.Boolean major, java.lang.String filter, org.alfresco.repo.cmis.ws.CmisExtensionType extension)
          Gets the properties of the latest version, or the latest major version, of the specified version series.
 
Methods inherited from class org.alfresco.repo.cmis.ws.DMAbstractServicePort
appendWithAce, appendWithRelationships, applyAclCarefully, applyPolicies, checkRepositoryId, convertAclReportToCmisAclType, createCmisObject, createCmisObject, createCmisObjectList, createCursor, createPropertyFilter, createPropertyFilter, determineObjectAllowableActions, getRenditions, isObjectInFolder, setAuthorityService, setCmisAclService, setCmisChangeLogService, setCmisQueryService, setCmisRenditionService, setCmisService, setDescriptorService, setFileFolderService, setNodeService, setPermissionService, setPropertiesUtil, setSearchService
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DMVersioningServicePort

public DMVersioningServicePort()
Method Detail

cancelCheckOut

public void cancelCheckOut(java.lang.String repositoryId,
                           java.lang.String objectId,
                           javax.xml.ws.Holder extension)
                    throws org.alfresco.repo.cmis.ws.CmisException
Reverses the effect of a check-out. Removes the private working copy of the checked-out document object, allowing other documents in the version series to be checked out again.

Specified by:
cancelCheckOut in interface org.alfresco.repo.cmis.ws.VersioningServicePort
Parameters:
repositoryId - repository Id
objectId - document Id
Throws:
CmisException - (with following EnumServiceException : INVALID_ARGUMENT, OBJECT_NOT_FOUND, NOT_SUPPORTED, PERMISSION_DENIED, RUNTIME, CONSTRAINT, UPDATE_CONFLICT, VERSIONING)

checkIn

public void checkIn(java.lang.String repositoryId,
                    javax.xml.ws.Holder objectId,
                    java.lang.Boolean major,
                    org.alfresco.repo.cmis.ws.CmisPropertiesType properties,
                    org.alfresco.repo.cmis.ws.CmisContentStreamType contentStream,
                    java.lang.String checkinComment,
                    java.util.List policies,
                    org.alfresco.repo.cmis.ws.CmisAccessControlListType addACEs,
                    org.alfresco.repo.cmis.ws.CmisAccessControlListType removeACEs,
                    javax.xml.ws.Holder extension)
             throws org.alfresco.repo.cmis.ws.CmisException
Makes the private working copy the current version of the document.

Specified by:
checkIn in interface org.alfresco.repo.cmis.ws.VersioningServicePort
Parameters:
repositoryId - repository Id
objectId - document Id
major - is major True (Default)
properties - CMIS properties
contentStream - content stream
checkinComment - check in comment
Throws:
CmisException - (with following EnumServiceException : INVALID_ARGUMENT, OBJECT_NOT_FOUND, NOT_SUPPORTED, PERMISSION_DENIED, RUNTIME, CONSTRAINT, STORAGE, STREAM_NOT_SUPPORTED, UPDATE_CONFLICT, VERSIONING)

checkOut

public void checkOut(java.lang.String repositoryId,
                     javax.xml.ws.Holder objectId,
                     javax.xml.ws.Holder extension,
                     javax.xml.ws.Holder contentCopied)
              throws org.alfresco.repo.cmis.ws.CmisException
Create a private working copy of the object, copies the metadata and optionally content.

Specified by:
checkOut in interface org.alfresco.repo.cmis.ws.VersioningServicePort
Parameters:
repositoryId - repository Id
objectId - ObjectID of document version to checkout
contentCopied -
Throws:
CmisException - (with following EnumServiceException : INVALID_ARGUMENT, OBJECT_NOT_FOUND, NOT_SUPPORTED, PERMISSION_DENIED, RUNTIME, CONSTRAINT, STORAGE, UPDATE_CONFLICT, VERSIONING)

getAllVersions

public java.util.List getAllVersions(java.lang.String repositoryId,
                                     java.lang.String objectId,
                                     java.lang.String filter,
                                     java.lang.Boolean includeAllowableActions,
                                     org.alfresco.repo.cmis.ws.CmisExtensionType extension)
                              throws org.alfresco.repo.cmis.ws.CmisException
Gets the list of all document versions for the specified version series.

Specified by:
getAllVersions in interface org.alfresco.repo.cmis.ws.VersioningServicePort
Parameters:
parameters - repositoryId: repository Id; versionSeriesId: version series Id; filter: property filter; includeAllowableActions; includeRelationships;
Returns:
list of CmisObjectType
Throws:
CmisException - (with following EnumServiceException : INVALID_ARGUMENT, OBJECT_NOT_FOUND, NOT_SUPPORTED, PERMISSION_DENIED, RUNTIME, FILTER_NOT_VALID)

getPropertiesOfLatestVersion

public org.alfresco.repo.cmis.ws.CmisPropertiesType getPropertiesOfLatestVersion(java.lang.String repositoryId,
                                                                                 java.lang.String objectId,
                                                                                 java.lang.Boolean major,
                                                                                 java.lang.String filter,
                                                                                 org.alfresco.repo.cmis.ws.CmisExtensionType extension)
                                                                          throws org.alfresco.repo.cmis.ws.CmisException
Gets the properties of the latest version, or the latest major version, of the specified version series.

Specified by:
getPropertiesOfLatestVersion in interface org.alfresco.repo.cmis.ws.VersioningServicePort
Parameters:
parameters - repositoryId: repository Id; versionSeriesId: version series Id; majorVersion: whether or not to return the latest major version. Default=FALSE; filter: property filter
Returns:
CmisObjectType with properties
Throws:
CmisException - (with following EnumServiceException : INVALID_ARGUMENT, OBJECT_NOT_FOUND, NOT_SUPPORTED, PERMISSION_DENIED, RUNTIME, FILTER_NOT_VALID)

getObjectOfLatestVersion

public org.alfresco.repo.cmis.ws.CmisObjectType getObjectOfLatestVersion(java.lang.String repositoryId,
                                                                         java.lang.String objectId,
                                                                         java.lang.Boolean major,
                                                                         java.lang.String filter,
                                                                         java.lang.Boolean includeAllowableActions,
                                                                         org.alfresco.repo.cmis.ws.EnumIncludeRelationships includeRelationships,
                                                                         java.lang.String renditionFilter,
                                                                         java.lang.Boolean includePolicyIds,
                                                                         java.lang.Boolean includeACL,
                                                                         org.alfresco.repo.cmis.ws.CmisExtensionType extension)
                                                                  throws org.alfresco.repo.cmis.ws.CmisException
Specified by:
getObjectOfLatestVersion in interface org.alfresco.repo.cmis.ws.VersioningServicePort
Throws:
org.alfresco.repo.cmis.ws.CmisException


Copyright © 2005 - 2010 Alfresco Software, Inc. All Rights Reserved.