it.sistematica.isharedoc.opencmis.indatabase.storedobj.api
Interface VersionedDocument

All Superinterfaces:

Filing, MultiFiling, StoredObject

All Known Implementing Classes:

VersionedDocumentImpl

public interface VersionedDocument
extends MultiFiling, StoredObject

A version series is a concrete object (meaning it can be stored) and has methods for check-out and checkin. It has a path (is contained in a folder) In contrast to a non-versioned document it has no content, but versions instead.

Author:

Jens

Field Summary

Fields inherited from interface it.sistematica.isharedoc.opencmis.indatabase.storedobj.api.Filing

PATH_SEPARATOR

Method Summary

DocumentVersion	addVersion(java.lang.String name, org.apache.chemistry.opencmis.commons.data.ContentStream content, org.apache.chemistry.opencmis.commons.enums.VersioningState verState, java.lang.String user)
void	cancelCheckOut(java.lang.String user)
void	checkIn(boolean isMajor, org.apache.chemistry.opencmis.commons.data.Properties properties, org.apache.chemistry.opencmis.commons.data.ContentStream content, java.lang.String checkinComment, java.util.List<java.lang.String> policyIds, java.lang.String user)
DocumentVersion	checkOut(org.apache.chemistry.opencmis.commons.data.ContentStream content, java.lang.String user)
boolean	deleteVersion(DocumentVersion version) delete a version from this object, throw exception if document is checked out or document does not contain this version
java.util.List<DocumentVersion>	getAllVersions()
java.lang.String	getCheckedOutBy()
DocumentVersion	getLatestVersion(boolean major)
DocumentVersion	getPwc()
boolean	isCheckedOut()

Methods inherited from interface it.sistematica.isharedoc.opencmis.indatabase.storedobj.api.MultiFiling

addParent, getPathSegment, removeParent

Methods inherited from interface it.sistematica.isharedoc.opencmis.indatabase.storedobj.api.Filing

getParents, hasParent, move

Methods inherited from interface it.sistematica.isharedoc.opencmis.indatabase.storedobj.api.StoredObject

addAcl, addAppliedPolicy, createSystemBasePropertiesWhenCreated, fillProperties, getAcl, getAllowableActions, getAppliedPolicies, getChangeToken, getCreatedAt, getCreatedBy, getDescription, getId, getModifiedAt, getModifiedBy, getName, getNativeObject, getObjectRelationships, getProperties, getRenditionContent, getRenditions, getRepositoryId, getSecondaryTypeIds, getTypeId, hasRendition, persist, removeAcl, removePolicy, rename, setCreatedAt, setCreatedBy, setCustomProperties, setDescription, setModifiedAtNow, setModifiedBy, setName, setNativeObject, setProperties, setRepositoryId, setTypeId, updateSystemBasePropertiesWhenModified

Method Detail

addVersion

DocumentVersion addVersion(java.lang.String name,
                           org.apache.chemistry.opencmis.commons.data.ContentStream content,
                           org.apache.chemistry.opencmis.commons.enums.VersioningState verState,
                           java.lang.String user)

deleteVersion

boolean deleteVersion(DocumentVersion version)

delete a version from this object, throw exception if document is checked out or document does not contain this version

Parameters:

version - version to be removed

Returns:

true if version could be removed, and other versions exist, false if the deleted version was the last version in this document

isCheckedOut

boolean isCheckedOut()

cancelCheckOut

void cancelCheckOut(java.lang.String user)

checkOut

DocumentVersion checkOut(org.apache.chemistry.opencmis.commons.data.ContentStream content,
                         java.lang.String user)

checkIn

void checkIn(boolean isMajor,
             org.apache.chemistry.opencmis.commons.data.Properties properties,
             org.apache.chemistry.opencmis.commons.data.ContentStream content,
             java.lang.String checkinComment,
             java.util.List<java.lang.String> policyIds,
             java.lang.String user)

getAllVersions

java.util.List<DocumentVersion> getAllVersions()

getLatestVersion

DocumentVersion getLatestVersion(boolean major)

getCheckedOutBy

java.lang.String getCheckedOutBy()

getPwc

DocumentVersion getPwc()