org.xcmis.spi.model
Class CmisObject

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

public class CmisObject
extends Object

Info about CMISobject that contains properties, allowable actions, relationships of object, etc. Set of this info determined by the user request. It minds any of getters may return null or empty collections if info provided by method was not requested even object contains such information.

Version:

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

Author:

Alexey Zavizionov

Constructor Summary

CmisObject()

CmisObject(Map<String,Property<?>> properties, List<AccessControlEntry> acl, boolean exactACL, Set<String> policyIds, List<CmisObject> relationships, List<Rendition> renditions, AllowableActions allowableActions, ChangeInfo changeInfo, ObjectInfo objectInfo, String pathSegment)

Method Summary

List<AccessControlEntry>	getACL()
AllowableActions	getAllowableActions()
ChangeInfo	getChangeInfo()
ObjectInfo	getObjectInfo()
String	getPathSegment()
Collection<String>	getPolicyIds()
Map<String,Property<?>>	getProperties()
List<CmisObject>	getRelationship()
List<Rendition>	getRenditions()
boolean	isExactACL()
void	setAllowableActions(AllowableActions allowableActions)
void	setChangeInfo(ChangeInfo changeInfo)
void	setExactACL(boolean exactACL)
void	setObjectInfo(ObjectInfo objectInfo)
void	setPathSegment(String pathSegment)

Methods inherited from class java.lang.Object

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

Constructor Detail

CmisObject

public CmisObject()

CmisObject

public CmisObject(Map<String,Property<?>> properties,
                  List<AccessControlEntry> acl,
                  boolean exactACL,
                  Set<String> policyIds,
                  List<CmisObject> relationships,
                  List<Rendition> renditions,
                  AllowableActions allowableActions,
                  ChangeInfo changeInfo,
                  ObjectInfo objectInfo,
                  String pathSegment)

Method Detail

getACL

public List<AccessControlEntry> getACL()

Returns:

object's ACL. Even object has not any applied ACL this method must return empty list but never null

getAllowableActions

public AllowableActions getAllowableActions()

Returns:

allowable actions

getChangeInfo

public ChangeInfo getChangeInfo()

Returns:

change info

getObjectInfo

public ObjectInfo getObjectInfo()

Returns:

external information about object. It is useful if other method does not provide required information about object because to caller constraint. For example getProperties() does not contains all required properties to build correct AtomPub document

getPathSegment

public String getPathSegment()

Returns:

path segment of object relative to the folder that contains this object. For Document may be 'cmis:name' or content stream filename

getPolicyIds

public Collection<String> getPolicyIds()

Returns:

set of policy IDs applied to the object. Even object has not any applied policies this method must return empty collection but never null

getProperties

public Map<String,Property<?>> getProperties()

Returns:

object's properties, never null

getRelationship

public List<CmisObject> getRelationship()

Returns:

objects relationships. Even object has not any relationships this method must return empty list but never null

getRenditions

public List<Rendition> getRenditions()

Returns:

content stream renditions. There is no rendition contents stream just information about available renditions. Even object has not any renditions this method must return empty list but never null

isExactACL

public boolean isExactACL()

Returns:

true if method getACL() provide information about all object's permissions and false if object's has other permissions. It may happen if repository displays only basic permissions Permission.BasicPermissions

setAllowableActions

public void setAllowableActions(AllowableActions allowableActions)

setChangeInfo

public void setChangeInfo(ChangeInfo changeInfo)

setObjectInfo

public void setObjectInfo(ObjectInfo objectInfo)

setExactACL

public void setExactACL(boolean exactACL)

setPathSegment

public void setPathSegment(String pathSegment)