|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface StoredObject
Stored Object interface is common part that all objects handled by CMIS (Documents, Folders, Relations, Policies, ACLs) share. Objects that implement this interface are always concrete and can live in the object store. A stored object always has an id, a name and properties.
Method Summary | |
---|---|
void |
createSystemBasePropertiesWhenCreated(java.util.Map<java.lang.String,PropertyData<?>> properties,
java.lang.String user)
Create all system base properties that need to be stored with every object in the repository This method is called when a new object is created to record all of the capturing data like the creation time, creator etc. |
void |
fillProperties(java.util.Map<java.lang.String,PropertyData<?>> properties,
BindingsObjectFactory objFactory,
java.util.List<java.lang.String> requestedIds)
|
Acl |
getAcl()
get the Acl of the stored object |
AllowableActions |
getAllowableActions(java.lang.String user)
|
java.lang.String |
getChangeToken()
Retrieve a change token uniquely identifying the state of the object when it was persisted (used for optimistic locking) |
java.util.GregorianCalendar |
getCreatedAt()
|
java.lang.String |
getCreatedBy()
Retrieve the user who created the document |
java.lang.String |
getId()
Retrieve the id of this object. |
java.util.GregorianCalendar |
getModifiedAt()
Retrieve date and time when the object was last modified. |
java.lang.String |
getModifiedBy()
Retrieve the user who last modified the document |
java.lang.String |
getName()
Retrieve the name of this object |
ObjectList |
getObjectRelationships(java.lang.Boolean includeSubRelationshipTypes,
RelationshipDirection relationshipDirection,
java.lang.String typeId,
java.lang.String filter,
java.lang.Boolean includeAllowableActions,
java.math.BigInteger maxItems,
java.math.BigInteger skipCount,
ExtensionsData extension,
java.lang.String user)
get the relationships of the object |
java.util.Map<java.lang.String,PropertyData<?>> |
getProperties()
Retrieve the list of properties |
java.lang.String |
getRepositoryId()
Get the repository id of this object where the object is stored. |
java.lang.String |
getTypeId()
Retrieve the type of this document. |
void |
persist()
Persist the object so that it can be later retrieved by its id. |
void |
rename(java.lang.String newName)
Rename an object |
void |
setCreatedAt(java.util.GregorianCalendar createdAt)
Assign date and time when the object was created. |
void |
setCreatedBy(java.lang.String createdBy)
Set the user who last modified the object. |
void |
setCustomProperties(java.util.Map<java.lang.String,PropertyData<?>> properties)
Set all properties which are not system properties. |
void |
setModifiedAtNow()
Assign current date and time when the object was last modified. |
void |
setModifiedBy(java.lang.String modifiedBy)
Set the user who last modified the object. |
void |
setName(java.lang.String name)
Set the name of this document. |
void |
setProperties(java.util.Map<java.lang.String,PropertyData<?>> props)
Assign the properties to an object. |
void |
setRepositoryId(java.lang.String repositoryId)
Assign a repository where this object will be stored. |
void |
setTypeId(java.lang.String type)
Set the type of this document. |
void |
updateSystemBasePropertiesWhenModified(java.util.Map<java.lang.String,PropertyData<?>> properties,
java.lang.String user)
Update all system base properties that need to be stored with every object in the repository This method is called when an object is is updated to record all of the capturing data like the modification time, updating user etc. |
Method Detail |
---|
java.lang.String getId()
java.lang.String getName()
void setName(java.lang.String name)
name
- name that is assigned to this objectjava.lang.String getTypeId()
void setTypeId(java.lang.String type)
type
- id of the type this object gets assigned.java.lang.String getCreatedBy()
void setCreatedBy(java.lang.String createdBy)
createdBy
- user who last modified the documentjava.lang.String getModifiedBy()
void setModifiedBy(java.lang.String modifiedBy)
modifiedBy
- user who last modified the documentjava.util.GregorianCalendar getCreatedAt()
void setCreatedAt(java.util.GregorianCalendar createdAt)
createdAt
- date the object was createdjava.util.GregorianCalendar getModifiedAt()
void setModifiedAtNow()
java.lang.String getRepositoryId()
void setRepositoryId(java.lang.String repositoryId)
repositoryId
- id of the repositoryjava.util.Map<java.lang.String,PropertyData<?>> getProperties()
void setProperties(java.util.Map<java.lang.String,PropertyData<?>> props)
props
- properties to be assignedjava.lang.String getChangeToken()
void persist()
void rename(java.lang.String newName)
newName
- the new name of the objectvoid createSystemBasePropertiesWhenCreated(java.util.Map<java.lang.String,PropertyData<?>> properties, java.lang.String user)
properties
- The properties passed by the client, containing, name, type,
etcuser
- The user creating the documentvoid updateSystemBasePropertiesWhenModified(java.util.Map<java.lang.String,PropertyData<?>> properties, java.lang.String user)
properties
- The properties passed by the client, containing, name, type,
etcuser
- The user creating the documentvoid fillProperties(java.util.Map<java.lang.String,PropertyData<?>> properties, BindingsObjectFactory objFactory, java.util.List<java.lang.String> requestedIds)
void setCustomProperties(java.util.Map<java.lang.String,PropertyData<?>> properties)
properties
- Set of properties as set by the client, including system
parametersAcl getAcl()
ObjectList getObjectRelationships(java.lang.Boolean includeSubRelationshipTypes, RelationshipDirection relationshipDirection, java.lang.String typeId, java.lang.String filter, java.lang.Boolean includeAllowableActions, java.math.BigInteger maxItems, java.math.BigInteger skipCount, ExtensionsData extension, java.lang.String user)
includeSubRelationshipTypes
- if true, relationships of a sub type will be returned as wellrelationshipDirection
- whether relationships where the object is the source, or the target or all
are returnedtypeId
- the type of the relationship, may be nullfilter
- a property filter, "*" means all propertiesincludeAllowableActions
- whether allowable actions should be returnedmaxItems
- skipCount
- extension
- user
- the id of the user calling the methodAllowableActions getAllowableActions(java.lang.String user)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |