org.xcmis.spi.model
Class ObjectInfo

java.lang.Object
  org.xcmis.spi.model.ObjectInfo

public final class ObjectInfo
extends Object

This interface is provided methods for object information holder. Particular this info is useful for AtomPub binding. AtomPub binding needs some information to build correct Atom document but this info may be excluded by property filter provided by client application. Method for retrieving CMIS object in Connection has additional parameter includeObjectInfo, e.g. Connection#getObject(String, boolean, org.xcmis.spi.IncludeRelationships, boolean, boolean, boolean, String, String) . If this parameter is true caller if method must get additional information about object, see CmisObject.getObjectInfo().

Version:

$Id: ObjectInfo.java 34360 2009-07-22 23:58:59Z sunman $

Author:

Alexey Zavizionov

Constructor Summary

ObjectInfo()

ObjectInfo(BaseType baseType, String typeId, String id, String name, String createdBy, Calendar creationDate, String lastModifiedBy, Calendar lastModificationDate, String changeToken, String parentId, Boolean latestVersion, Boolean majorVersion, Boolean latestMajorVersion, String versionSeriesId, String versionSeriesCheckedOutId, String versionSeriesCheckedOutBy, String versionLabel, String contentStreamMimeType, String sourceId, String targetId)

Method Summary

BaseType	getBaseType() Base object type.
String	getChangeToken() Property CmisConstants.CHANGE_TOKEN.
String	getContentStreamMimeType() Property CmisConstants.CONTENT_STREAM_MIME_TYPE.
String	getCreatedBy() Property CmisConstants.CREATED_BY.
Calendar	getCreationDate() Property CmisConstants.CREATION_DATE.
String	getId() Property CmisConstants.OBJECT_ID.
Calendar	getLastModificationDate() Property CmisConstants.LAST_MODIFICATION_DATE.
String	getLastModifiedBy() Property CmisConstants.LAST_MODIFIED_BY.
String	getName() Property CmisConstants.NAME.
String	getParentId() Property CmisConstants.PARENT_ID.
String	getSourceId() Property CmisConstants.SOURCE_ID.
String	getTargetId() Property CmisConstants.TARGET_ID.
String	getTypeId() Object type id.
String	getVersionLabel() Property CmisConstants.VERSION_LABEL.
String	getVersionSeriesCheckedOutBy() Property CmisConstants.VERSION_SERIES_CHECKED_OUT_BY.
String	getVersionSeriesCheckedOutId() Property CmisConstants.VERSION_SERIES_CHECKED_OUT_ID.
String	getVersionSeriesId() Property CmisConstants.VERSION_SERIES_ID.
Boolean	isLatestMajorVersion() Property CmisConstants.IS_LATEST_MAJOR_VERSION.
Boolean	isLatestVersion() Property CmisConstants.IS_LATEST_VERSION.
Boolean	isMajorVersion() Property CmisConstants.IS_MAJOR_VERSION.
void	setBaseType(BaseType baseType)
void	setChangeToken(String changeToken)
void	setContentStreamMimeType(String contentStreamMimeType)
void	setCreatedBy(String createdBy)
void	setCreationDate(Calendar creationDate)
void	setId(String id)
void	setLastModificationDate(Calendar lastModificationDate)
void	setLastModifiedBy(String lastModifiedBy)
void	setLatestMajorVersion(Boolean latestMajorVersion)
void	setLatestVersion(Boolean latestVersion)
void	setMajorVersion(Boolean majorVersion)
void	setName(String name)
void	setParentId(String parentId)
void	setSourceId(String sourceId)
void	setTargetId(String targetId)
void	setTypeId(String typeId)
void	setVersionLabel(String versionLabel)
void	setVersionSeriesCheckedOutBy(String versionSeriesCheckedOutBy)
void	setVersionSeriesCheckedOutId(String versionSeriesCheckedOutId)
void	setVersionSeriesId(String versionSeriesId)

Methods inherited from class java.lang.Object

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

Constructor Detail

ObjectInfo

public ObjectInfo()

ObjectInfo

public ObjectInfo(BaseType baseType,
                  String typeId,
                  String id,
                  String name,
                  String createdBy,
                  Calendar creationDate,
                  String lastModifiedBy,
                  Calendar lastModificationDate,
                  String changeToken,
                  String parentId,
                  Boolean latestVersion,
                  Boolean majorVersion,
                  Boolean latestMajorVersion,
                  String versionSeriesId,
                  String versionSeriesCheckedOutId,
                  String versionSeriesCheckedOutBy,
                  String versionLabel,
                  String contentStreamMimeType,
                  String sourceId,
                  String targetId)

Method Detail

getBaseType

public BaseType getBaseType()

Base object type.

Returns:

base type

See Also:

BaseType

getTypeId

public String getTypeId()

Object type id.

Returns:

type id

getId

public String getId()

Property CmisConstants.OBJECT_ID.

Returns:

object id

getName

public String getName()

Property CmisConstants.NAME.

Returns:

object name

getCreatedBy

public String getCreatedBy()

Property CmisConstants.CREATED_BY.

Returns:

principal id whose created object

getCreationDate

public Calendar getCreationDate()

Property CmisConstants.CREATION_DATE.

Returns:

creation date

getLastModifiedBy

public String getLastModifiedBy()

Property CmisConstants.LAST_MODIFIED_BY.

Returns:

principal id whose made last modification

getLastModificationDate

public Calendar getLastModificationDate()

Property CmisConstants.LAST_MODIFICATION_DATE.

Returns:

last modification date

getChangeToken

public String getChangeToken()

Property CmisConstants.CHANGE_TOKEN.

Returns:

change token property or null if change token feature is not supported

getParentId

public String getParentId()

Property CmisConstants.PARENT_ID.

Returns:

null for object with base type other then 'cmis:folder'

isLatestVersion

public Boolean isLatestVersion()

Property CmisConstants.IS_LATEST_VERSION.

Returns:

null for non-document object and always true versionable document. Not versionable document also has exactly one version

isMajorVersion

public Boolean isMajorVersion()

Property CmisConstants.IS_MAJOR_VERSION.

Returns:

null for non-document object not versionable document

isLatestMajorVersion

public Boolean isLatestMajorVersion()

Property CmisConstants.IS_LATEST_MAJOR_VERSION.

Returns:

null for non-document object or not versionable document

getVersionSeriesId

public String getVersionSeriesId()

Property CmisConstants.VERSION_SERIES_ID.

Returns:

null for non-document object

getVersionSeriesCheckedOutId

public String getVersionSeriesCheckedOutId()

Property CmisConstants.VERSION_SERIES_CHECKED_OUT_ID.

Returns:

id of checked-out document if any. Always null for non-document object or not versionable document

getVersionSeriesCheckedOutBy

public String getVersionSeriesCheckedOutBy()

Property CmisConstants.VERSION_SERIES_CHECKED_OUT_BY.

Returns:

principal id whose checked-out document if any. Always null for non-document object or not versionable document

getVersionLabel

public String getVersionLabel()

Property CmisConstants.VERSION_LABEL.

Returns:

null for non-document object

getContentStreamMimeType

public String getContentStreamMimeType()

Property CmisConstants.CONTENT_STREAM_MIME_TYPE.

Returns:

null for non-document object or document without content

getSourceId

public String getSourceId()

Property CmisConstants.SOURCE_ID.

Returns:

null for objects with base type other then 'cmis:relationship'

getTargetId

public String getTargetId()

Property CmisConstants.TARGET_ID.

Returns:

null for objects with base type other then 'cmis:relationship'

setBaseType

public void setBaseType(BaseType baseType)

setTypeId

public void setTypeId(String typeId)

setId

public void setId(String id)

setName

public void setName(String name)

setCreatedBy

public void setCreatedBy(String createdBy)

setCreationDate

public void setCreationDate(Calendar creationDate)

setLastModifiedBy

public void setLastModifiedBy(String lastModifiedBy)

setLastModificationDate

public void setLastModificationDate(Calendar lastModificationDate)

setChangeToken

public void setChangeToken(String changeToken)

setParentId

public void setParentId(String parentId)

setLatestVersion

public void setLatestVersion(Boolean latestVersion)

setMajorVersion

public void setMajorVersion(Boolean majorVersion)

setLatestMajorVersion

public void setLatestMajorVersion(Boolean latestMajorVersion)

setVersionSeriesId

public void setVersionSeriesId(String versionSeriesId)

setVersionSeriesCheckedOutId

public void setVersionSeriesCheckedOutId(String versionSeriesCheckedOutId)

setVersionSeriesCheckedOutBy

public void setVersionSeriesCheckedOutBy(String versionSeriesCheckedOutBy)

setVersionLabel

public void setVersionLabel(String versionLabel)

setContentStreamMimeType

public void setContentStreamMimeType(String contentStreamMimeType)

setSourceId

public void setSourceId(String sourceId)

setTargetId

public void setTargetId(String targetId)