cmis: Attributes common to ALL Object-Type Property Definitions

Attribute	Description	Data Type
id	This opaque attribute uniquely identifies the property in the repository.	Id
localName	This attribute represents the underlying repository's name for the property.	String
localNamespace	This attribute allows repositories to represent the internal namespace of the underlying repository's name for the property.	String
queryName	Used for query operation on properties	String
displayName	Used for presentation by application.	String
description	This is an optional attribute containing a description of the property.	String
propertyType	This attribute indicates the type of this property. It MUST be one of the allowed property types (string, boolean, decimal, integer, datetime and uri).	Enum
cardinality	Indicates whether the property can have "zero or one" or "zero or more" values. single : Property can have zero or one values (if property is not required), or exactly one value (if property is required). multi: Property can have zero or more values (if property is not required), or one or more values (if property is required).	Enum
updatability	Indicates under what circumstances the value of this property MAY be updated. Possible values are: readonly, readwrite, whencheckedout, oncreate. readonly: The value of the property is readonly, the value will be updated with indirect interactions. For example, the modification date of the cmis object will be update once the cmis object is updated, but you can’t update the property directly. readwrite: The property value can be modified using the updateProperties service. Whencheckedout: The property value MUST only be update-able using a "private working copy" document. That is, the update is either made on a "private working copy" object or made using the checkIn service. oncreate: The property value MUST only be update-able during the create operation on that object.	Enum
inherited	Indicates whether the property definition is inherited from the parent type when TRUE or it is explicitly defined for this object-type when FALSE.	Boolean
required	If this is set to true, then the value must be set for the property. If the value is not provided during a create or update operation, the repository MUST provide a value for this property. If a value is not provided, then the default value defined for the property MUST be set. If no default value is provided and no default value is defined, the repository MUST throw a constraint exception.	Boolean
queryable	Indicates whether or not the property MAY appear in the WHERE clause of a CMIS query statement. This attribute MUST have a value of FALSE if the object-type's attribute for "queryable" is set to FALSE.	Boolean
orderable	Indicates whether the property can appear in the ORDER BY clause of a CMIS query statement or an orderBy parameter of getChildren or getCheckedOutDocs. This property MUST be FALSE for any property whose cardinality is "multi".	Boolean
choices	Indicates an explicit ordered set of single values allowed for this property. If the cardinatity of the property definition is "single" and the "openChoice" attribute is FALSE, then the property value MUST be at most one of the values listed in this attribute. If the cardinatity of the property definition is "single" and the "openChoice" attribute is TRUE, then the property value MAY be one of the values listed in this attribute. If the cardinatity of the property definition is "multi" and the "openChoice" attribute is FALSE, then the property value MUST be zero, one or more than one of the values listed in this attribute. If the cardinatity of the property definition is "multi" and the "openChoice" attribute is TRUE, then the property value MAY be zero, one, or more than one of the values listed in this attribute. If this attribute is "not set", then any valid value for this property based on its type may be used. Each choice includes a displayName and a value. The displayName is used for presentation purpose.	<PropertyChoiceType list> (multi-valued, optional)
openChoice	This attribute is only applicable to properties that provide a value for the "Choices" attribute. If FALSE, then the data value for the property MUST only be one of the values specified in the "Choices" attribute. If TRUE, then values other than those included in the "Choices" attribute may be set for the property.	Boolean
defaultValue	The value that the repository MUST set for the property if a value is not provided by an application when the object is created. If no default value is specified and an application creates an object of this type without setting a value for the property, the repository MUST attempt to store a "not set" property value. If this occurs for a property that is defined to be required, then the creation attempt MUST throw an exception.	<PropertyType>

Previous                                                 Next                                                 Home