Versionable Properties

This topic alphabetically lists the properties that apply to the Versionable class.

ActiveMarkings Property



The list of ActiveMarking objects currently applied to a given object. Each ActiveMarking object represents a marking that is in a MarkingSet associated with a property on the object.

Metadata

AllowsDefaultChange: false
Cardinality: LIST
CopyToReservation: false
DataType: OBJECT
DeletionAction: NONE
IsHidden: false
IsOrderable: false
IsSearchable: false
IsValueRequired: false
ModificationAccessRequired: WRITE
PersistenceType: NOT_PERSISTENT
ReflectiveProperty: null
RequiredClass: ActiveMarking
RequiresUniqueElements: true
Settability: READ_ONLY
TargetAccessRequired: READ

Annotations Property



Specifies an AnnotationSet object that contains the annotations associated with this object.

Metadata

AllowsDefaultChange: false
Cardinality: ENUM
CopyToReservation: false
DataType: OBJECT
DeletionAction: CASCADE
IsHidden: false
IsOrderable: false
IsSearchable: false
IsValueRequired: false
ModificationAccessRequired: WRITE
PersistenceType: OWN_COLUMN
ReflectiveProperty: AnnotatedObject
RequiredClass: Annotation
RequiresUniqueElements: false
Settability: READ_ONLY
TargetAccessRequired: READ

AuditedEvents Property



An EventSet collection of the Event objects containing the audited events that have occurred for the object.

Metadata

AllowsDefaultChange: false
Cardinality: ENUM
CopyToReservation: false
DataType: OBJECT
DeletionAction: NONE
IsHidden: true
IsOrderable: false
IsSearchable: false
IsValueRequired: false
ModificationAccessRequired: WRITE
PersistenceType: OWN_COLUMN
ReflectiveProperty: null
RequiredClass: Event
RequiresUniqueElements: false
Settability: READ_ONLY
TargetAccessRequired: READ

ClassDescription Property



Specifies a ClassDescription object containing the fixed description (immutable metadata) of the class from which this object is instantiated.

Metadata

AllowsDefaultChange: false
Cardinality: SINGLE
CopyToReservation: false
DataType: OBJECT
DeletionAction: NONE
IsHidden: true
IsOrderable: true
IsSearchable: true
IsValueRequired: true
ModificationAccessRequired: WRITE
PersistenceType: NOT_PERSISTENT
ReflectiveProperty: null
RequiredClass: ClassDescription
RequiresUniqueElements: false
Settability: READ_ONLY
TargetAccessRequired: READ

CmHoldRelationships Property



An enumeration of CmHoldRelationship objects associated with this object.

Metadata

AllowsDefaultChange: false
Cardinality: ENUM
CopyToReservation: false
DataType: OBJECT
DeletionAction: PREVENT
IsHidden: false
IsOrderable: false
IsSearchable: false
IsValueRequired: false
ModificationAccessRequired: WRITE
PersistenceType: NOT_PERSISTENT
ReflectiveProperty: HeldObject
RequiredClass: CmHoldRelationship
RequiresUniqueElements: false
Settability: READ_ONLY
TargetAccessRequired: READ

CmIsMarkedForDeletion Property



Indicates whether the object is marked (flagged) for deletion. If true, the object is the original object explicitly marked for deletion by a user, or the object is referenced by the original object through an object-valued property (OVP), and, therefore, was marked for deletion by the server.

Objects marked for deletion are represented by a CmRecoveryItem object, through which the objects can be either recovered or purged (removed from the object store database).

See Recovery Bin Concepts

Metadata

AllowsDefaultChange: false
Cardinality: SINGLE
CopyToReservation: false
DataType: BOOLEAN
IsHidden: false
IsOrderable: false
IsSearchable: false
IsValueRequired: false
ModificationAccessRequired: WRITE
PersistenceType: OWN_COLUMN
PropertyDefaultBoolean: false
RequiresUniqueElements: false
Settability: READ_ONLY
TargetAccessRequired: READ

Containers Property



A ReferentialContainmentRelationshipSet collection object containing the ReferentialContainmentRelationship objects that identify the containers of this object.

Metadata

AllowsDefaultChange: false
Cardinality: ENUM
CopyToReservation: false
DataType: OBJECT
DeletionAction: NONE
IsHidden: false
IsOrderable: false
IsSearchable: false
IsValueRequired: false
ModificationAccessRequired: WRITE
PersistenceType: OWN_COLUMN
ReflectiveProperty: null
RequiredClass: ContainmentRelationship
RequiresUniqueElements: false
Settability: READ_ONLY
TargetAccessRequired: READ

CoordinatedTasks Property



The enumeration of tasks coordinated by the Containable object. Each CmTask object in the enumeration represents a single piece of work in a business process. A CmTask object with a Coordinator property set to this Containable object is added to the enumeration value of this property.

Metadata

AllowsDefaultChange: false
Cardinality: ENUM
CopyToReservation: false
DataType: OBJECT
DeletionAction: CASCADE
IsHidden: false
IsOrderable: false
IsSearchable: false
IsValueRequired: false
ModificationAccessRequired: WRITE
PersistenceType: NOT_PERSISTENT
ReflectiveProperty: Coordinator
RequiredClass: CmTask
RequiresUniqueElements: false
Settability: READ_ONLY
TargetAccessRequired: READ

Creator Property



Indicates the name of the user assigned as the creator of the object.

Settability of this property is read-only for most users. For users who have been granted privileged write access (AccessRight.PRIVILEGED_WRITE), this property is settable only on create. After initial object creation, this property is read-only for all users.

Metadata

AllowsDefaultChange: false
Cardinality: SINGLE
CopyToReservation: false
DataType: STRING
IsHidden: false
IsOrderable: true
IsSearchable: true
IsValueRequired: false
MaximumLengthString: 80
ModificationAccessRequired: WRITE
PersistenceType: OWN_COLUMN
RequiresUniqueElements: false
Settability: SETTABLE_ONLY_ON_CREATE
TargetAccessRequired: READ

CurrentVersion Property



Specifies a document version that represents the latest checked-in version associated with this document or version series. The current version can be either a major version or a minor version.

Metadata

AllowsDefaultChange: false
Cardinality: SINGLE
CopyToReservation: false
DataType: OBJECT
DeletionAction: NONE
IsHidden: true
IsOrderable: false
IsSearchable: false
IsValueRequired: false
ModificationAccessRequired: WRITE
PersistenceType: NOT_PERSISTENT
ReflectiveProperty: null
RequiredClass: Versionable
RequiresUniqueElements: false
Settability: READ_ONLY
TargetAccessRequired: READ

DateCheckedIn Property



Specifies the date and time that this document was checked in. The Content Engine stores dates and times using Coordinated Universal Time (UTC). For more information, see Timestamps.

The server sets this property on a document version when it is checked in and it remains set throughout the life of the document version. When a document is checked out, the server sets this property on the document's reservation object to null.

Settability of this property is read-only for most users. Users who have been granted privileged write access (AccessRight.PRIVILEGED_WRITE) can set this property on a document while it is being checked in. Note that although the settability of this property for users with privileged write access is SETTABLE_ONLY_BEFORE_CHECKIN, those users can not set this property on a document prior to check in; it can be set only while a document is being checked in.

Metadata

AllowsDefaultChange: false
Cardinality: SINGLE
CopyToReservation: false
DataType: DATE
IsHidden: false
IsOrderable: true
IsSearchable: true
IsValueRequired: false
ModificationAccessRequired: WRITE
PersistenceType: OWN_COLUMN
RequiresUniqueElements: false
Settability: SETTABLE_ONLY_BEFORE_CHECKIN
TargetAccessRequired: READ

DateCreated Property



Indicates the date and time the object was created. The Content Engine server stores dates and times using Coordinated Universal Time (UTC). For more information, see Timestamps.

Settability of this property is read-only for most users. For users who have been granted privileged write access (AccessRight.PRIVILEGED_WRITE), this property is settable only on create. After initial object creation, this property is read-only for all users.

Metadata

AllowsDefaultChange: false
Cardinality: SINGLE
CopyToReservation: false
DataType: DATE
IsHidden: false
IsOrderable: true
IsSearchable: true
IsValueRequired: false
ModificationAccessRequired: WRITE
PersistenceType: OWN_COLUMN
RequiresUniqueElements: false
Settability: SETTABLE_ONLY_ON_CREATE
TargetAccessRequired: READ

DateLastModified Property



Indicates the date and time the object was last modified. The Content Engine server stores dates and times using Coordinated Universal Time (UTC). For more information, see Timestamps.

Settability of this property is read-only for most users. For users who have been granted privileged write access (AccessRight.PRIVILEGED_WRITE), this property is read/write. (The read/write access for those users can only change if a change is made to the ACL on the object store that controls who has privileged write access to objects in that object store).

Metadata

AllowsDefaultChange: false
Cardinality: SINGLE
CopyToReservation: false
DataType: DATE
IsHidden: false
IsOrderable: true
IsSearchable: true
IsValueRequired: false
ModificationAccessRequired: WRITE
PersistenceType: OWN_COLUMN
RequiresUniqueElements: false
Settability: READ_WRITE
TargetAccessRequired: READ

ExternalReplicaIdentities Property



Specifies an ExternalIdentityList collection of the read-only ExternalIdentity objects that represent the identities of replicas of this object in external repositories.

Metadata

AllowsDefaultChange: false
Cardinality: LIST
CopyToReservation: false
DataType: OBJECT
DeletionAction: NONE
IsHidden: true
IsOrderable: false
IsSearchable: true
IsValueRequired: false
ModificationAccessRequired: WRITE
PersistenceType: OWN_COLUMN
ReflectiveProperty: null
RequiredClass: ExternalIdentity
RequiresUniqueElements: true
Settability: READ_WRITE
TargetAccessRequired: READ

FoldersFiledIn Property



A FolderSet collection object containing the Folder objects in which this document is filed.

Metadata

AllowsDefaultChange: false
Cardinality: ENUM
CopyToReservation: false
DataType: OBJECT
DeletionAction: NONE
IsHidden: false
IsOrderable: false
IsSearchable: false
IsValueRequired: false
ModificationAccessRequired: WRITE
PersistenceType: OWN_COLUMN
ReflectiveProperty: null
RequiredClass: Container
RequiresUniqueElements: false
Settability: READ_ONLY
TargetAccessRequired: READ

Id Property



A representation of the Globally Unique Identifier (GUID), a unique 128-bit number, that is assigned to this Content Engine object when the object is created. When converted to a string, the Id property is typically depicted as 32 hexadecimal characters enclosed by brackets in the following format: {xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx}. For example, {3F2504E0-4F89-11D3-9A0C-0305E82C3301}.

For User and Group classes, the Id property takes the value of the Security Identifier (SID) rather than the 128-bit GUID. The string representation of the SID is in this example format: S-1-5-21-1559522492-2815155736-3711640725-55269. When Active Directory is used as the directory service for IBM FileNet P8, calls to User.get_Id() and Group.get_Id() always return the current SID for the principal, even if this user or group has only historical SIDs populating the Active Directory server.

For a given property representation, the Id property has the following characteristics:

For a newly created document object, you can override the Id property of its associated VersionSeries object before you save or check in the document for the first time.

Metadata

AllowsDefaultChange: false
Cardinality: SINGLE
CopyToReservation: false
DataType: GUID
IsHidden: false
IsOrderable: true
IsSearchable: true
IsValueRequired: false
ModificationAccessRequired: WRITE
PersistenceType: OWN_COLUMN
RequiresUniqueElements: false
Settability: READ_ONLY
TargetAccessRequired: READ

IsCurrentVersion Property



Specifies whether this document version is the current (latest) version object of a document's version series (true) or not (false). The current version can be a major version or a minor version.

Metadata

AllowsDefaultChange: false
Cardinality: SINGLE
CopyToReservation: false
DataType: BOOLEAN
IsHidden: false
IsOrderable: true
IsSearchable: true
IsValueRequired: true
ModificationAccessRequired: WRITE
PersistenceType: OWN_COLUMN
PropertyDefaultBoolean: false
RequiresUniqueElements: false
Settability: READ_ONLY
TargetAccessRequired: READ

IsFrozenVersion Property



Specifies whether this document version is a frozen version (true) or not (false). If a document version is frozen, you cannot modify its custom properties. However, you may be able to modify the custom properties of other versions of that document, provided they have not been frozen. Note that the modifiability of a document's system properties is not affected by a document version's frozen status.

Metadata

AllowsDefaultChange: false
Cardinality: SINGLE
CopyToReservation: false
DataType: BOOLEAN
IsHidden: false
IsOrderable: true
IsSearchable: true
IsValueRequired: true
ModificationAccessRequired: WRITE
PersistenceType: OWN_COLUMN
PropertyDefaultBoolean: false
RequiresUniqueElements: false
Settability: READ_ONLY
TargetAccessRequired: READ

IsReserved Property



For a Document object, specifies whether a user has reserved the right to check in the next version following this version (true) or not (false). For a VersionSeries object, specifies whether the current version in this version series is checked out (true) or not (false).

Metadata

AllowsDefaultChange: false
Cardinality: SINGLE
CopyToReservation: false
DataType: BOOLEAN
IsHidden: false
IsOrderable: true
IsSearchable: true
IsValueRequired: true
ModificationAccessRequired: WRITE
PersistenceType: OWN_COLUMN
PropertyDefaultBoolean: false
RequiresUniqueElements: false
Settability: READ_ONLY
TargetAccessRequired: READ

IsVersioningEnabled Property



Specifies whether you can create a new version of this object (true) or not (false).

Metadata

AllowsDefaultChange: true
Cardinality: SINGLE
CopyToReservation: false
DataType: BOOLEAN
IsHidden: false
IsOrderable: true
IsSearchable: true
IsValueRequired: true
ModificationAccessRequired: WRITE
PersistenceType: OWN_COLUMN
PropertyDefaultBoolean: true
RequiresUniqueElements: false
Settability: READ_ONLY
TargetAccessRequired: READ

LastModifier Property



Indicates the name of the user who last modified this object.

Settability of this property is read-only for most users. For users who have been granted privileged write access (AccessRight.PRIVILEGED_WRITE), this property is read/write. (The read/write access for those users could only change if a change is made to the ACL on the object store that controls who has privileged write access to objects in that object store).

Metadata

AllowsDefaultChange: false
Cardinality: SINGLE
CopyToReservation: false
DataType: STRING
IsHidden: false
IsOrderable: true
IsSearchable: true
IsValueRequired: false
MaximumLengthString: 80
ModificationAccessRequired: WRITE
PersistenceType: OWN_COLUMN
RequiresUniqueElements: false
Settability: READ_WRITE
TargetAccessRequired: READ

LockOwner Property



Identifies the owner that exclusively holds the advisory lock on the object. This property is populated as a result of a successful call to the lock method. The value of this property is simply a custom string that has no real effect in determining the user of the lock. The owner specified by this property is not validated against any user or group known to the Content Engine. This property is set to null if the unlock method is called; if the lock expires naturally, then the value remains unchanged.

Metadata

AllowsDefaultChange: false
Cardinality: SINGLE
CopyToReservation: false
DataType: STRING
IsHidden: true
IsOrderable: true
IsSearchable: true
IsValueRequired: false
MaximumLengthString: 64
ModificationAccessRequired: WRITE
PersistenceType: NOT_PERSISTENT
RequiresUniqueElements: false
Settability: READ_WRITE
TargetAccessRequired: READ

LockTimeout Property



The number of seconds beyond the last modified date that the server will retain a lock. This property's value is used to calculate a lock's expiration time. The property's value is populated as a result of a successful call to the lock method; however, the value can be updated by a call to updateLock. The property value is the number of seconds beyond the value in the object's DateLastModified property that the user of the lock can hold the lock on the object. The result of the calculation is measured against the current system time. The lock is considered expired when the value of the object's DateLastModified property plus the value of the LockTimeout property is less than the current system time. (All millisecond components are dropped from the calculation.) This property is set to null if the unlock method is called; if the lock expires naturally, then the value remains unchanged.

Metadata

AllowsDefaultChange: false
Cardinality: SINGLE
CopyToReservation: false
DataType: LONG
IsHidden: true
IsOrderable: true
IsSearchable: true
IsValueRequired: false
ModificationAccessRequired: WRITE
PersistenceType: NOT_PERSISTENT
PropertyDefaultInteger32: null
PropertyMaximumInteger32: null
PropertyMinimumInteger32: null
RequiresUniqueElements: false
Settability: READ_WRITE
TargetAccessRequired: READ

LockToken Property



Identifies the token used to signal that a lock exists on an object. The token is a unique identifier (GUID) that represents the lock. When the lock on the object is released (via unlock), the value of LockToken is set to null. (If the lock expires naturally, then the value remains unchanged.)

Metadata

AllowsDefaultChange: false
Cardinality: SINGLE
CopyToReservation: false
DataType: GUID
IsHidden: true
IsOrderable: true
IsSearchable: true
IsValueRequired: false
ModificationAccessRequired: WRITE
PersistenceType: NOT_PERSISTENT
RequiresUniqueElements: false
Settability: READ_WRITE
TargetAccessRequired: READ

MajorVersionNumber Property



Specifies the major version number of this document version. A document's major version number is set to 1 the first time that you check it in as a major version and then incremented by 1 for each additional time that you check it in as a major version.

Metadata

AllowsDefaultChange: false
Cardinality: SINGLE
CopyToReservation: false
DataType: LONG
IsHidden: false
IsOrderable: true
IsSearchable: true
IsValueRequired: true
ModificationAccessRequired: WRITE
PersistenceType: OWN_COLUMN
PropertyDefaultInteger32: null
PropertyMaximumInteger32: null
PropertyMinimumInteger32: null
RequiresUniqueElements: false
Settability: READ_ONLY
TargetAccessRequired: READ

MinorVersionNumber Property



Specifies the minor version number of this document version. A document's minor version number is set to 1 the first time that you check it in as a minor version and then incremented by 1 for each additional time that you check it in as a minor version. Note that if you check in a document as a major version, its minor version number will be reset to 0.

Metadata

AllowsDefaultChange: false
Cardinality: SINGLE
CopyToReservation: false
DataType: LONG
IsHidden: false
IsOrderable: true
IsSearchable: true
IsValueRequired: true
ModificationAccessRequired: WRITE
PersistenceType: OWN_COLUMN
PropertyDefaultInteger32: null
PropertyMaximumInteger32: null
PropertyMinimumInteger32: null
RequiresUniqueElements: false
Settability: READ_ONLY
TargetAccessRequired: READ

Name Property



The name for this object.

For most classes, this property is read-only and returns the value of the designated name property for the object, or its ID if there is no name property. If ClassDescription.NamePropertyIndex has a value, this property contains the value of the designated name property. If there is no designated name property value, and the object has an Id property, this property contains the string value of the Id property. If neither of these conditions is satisfied, this property contains an empty string.

For a ComponentRelationship object, this property is read/write and specifies the name of the object.

Metadata

AllowsDefaultChange: false
Cardinality: SINGLE
CopyToReservation: false
DataType: STRING
IsHidden: true
IsOrderable: false
IsSearchable: false
IsValueRequired: false
MaximumLengthString: null
ModificationAccessRequired: WRITE
PersistenceType: NOT_PERSISTENT
RequiresUniqueElements: false
Settability: READ_ONLY
TargetAccessRequired: READ

Owner Property



Manages the security owner assigned to the object.

Metadata

AllowsDefaultChange: false
Cardinality: SINGLE
CopyToReservation: false
DataType: STRING
IsHidden: true
IsOrderable: false
IsSearchable: false
IsValueRequired: false
MaximumLengthString: null
ModificationAccessRequired: WRITE_OWNER
PersistenceType: OWN_COLUMN
RequiresUniqueElements: false
Settability: READ_WRITE
TargetAccessRequired: READ

Permissions Property



Manages the discretionary permissions assigned to the object.

Metadata

AllowsDefaultChange: false
Cardinality: LIST
CopyToReservation: false
DataType: OBJECT
DeletionAction: NONE
IsHidden: true
IsOrderable: false
IsSearchable: false
IsValueRequired: false
ModificationAccessRequired: WRITE_ACL
PersistenceType: OWN_COLUMN
ReflectiveProperty: null
RequiredClass: DiscretionaryPermission
RequiresUniqueElements: false
Settability: READ_WRITE
TargetAccessRequired: READ

ReleasedVersion Property



Specifies a document version that represents the latest released version associated with this document or version series. A released version is a major version that has a VersionStatus property value of RELEASED. Note that only one document version at a time in a given version series can be in the released state.

Metadata

AllowsDefaultChange: false
Cardinality: SINGLE
CopyToReservation: false
DataType: OBJECT
DeletionAction: NONE
IsHidden: true
IsOrderable: false
IsSearchable: false
IsValueRequired: false
ModificationAccessRequired: WRITE
PersistenceType: NOT_PERSISTENT
ReflectiveProperty: null
RequiredClass: Versionable
RequiresUniqueElements: false
Settability: READ_ONLY
TargetAccessRequired: READ

ReplicationGroup Property



Specifies a ReplicationGroup object representing the replication group to which this replicable object belongs. For ReplicationJournalEntry objects only, this property represents the replication group to which the source object of the replication operation generating this journal entry belongs.

Metadata

AllowsDefaultChange: true
Cardinality: SINGLE
CopyToReservation: false
DataType: OBJECT
DeletionAction: NONE
IsHidden: true
IsOrderable: true
IsSearchable: true
IsValueRequired: false
ModificationAccessRequired: WRITE_ACL
PersistenceType: OWN_COLUMN
ReflectiveProperty: null
RequiredClass: ReplicationGroup
RequiresUniqueElements: false
Settability: READ_WRITE
TargetAccessRequired: READ

Reservation Property



Specifies the reservation object of this object's version series, which has a VersionStatus property value of RESERVATION. A reservation object is created by the server when you check out a document, which you can modify and check in as a new version of that document.

Metadata

AllowsDefaultChange: false
Cardinality: SINGLE
CopyToReservation: false
DataType: OBJECT
DeletionAction: NONE
IsHidden: false
IsOrderable: false
IsSearchable: false
IsValueRequired: false
ModificationAccessRequired: WRITE
PersistenceType: NOT_PERSISTENT
ReflectiveProperty: null
RequiredClass: Versionable
RequiresUniqueElements: false
Settability: READ_ONLY
TargetAccessRequired: READ

ReservationType Property



A ReservationType constant that specifies the type of this document reservation (collaborative or exclusive) or whether its reservation type is the same as the default object store setting.

The ReservationType property can have one of the values in the following table.

Name Value Description
COLLABORATIVE 16 Specifies a collaborative reservation, which is a reservation that any user with the appropriate permissions can check in, modify, or delete.
EXCLUSIVE 32 Specifies an exclusive reservation. For this type of reservation, only the user who checked out the document can check it in. This user and a user with Full Control access can delete the reservation.
OBJECT_STORE_DEFAULT 0 Specifies that the reservation type is the same as the default reservation type for the object store, which is specified by the DefaultReservationType property.

Metadata

AllowsDefaultChange: false
Cardinality: SINGLE
CopyToReservation: false
DataType: LONG
IsHidden: false
IsOrderable: true
IsSearchable: true
IsValueRequired: false
ModificationAccessRequired: WRITE
PersistenceType: OWN_COLUMN
PropertyDefaultInteger32: null
PropertyMaximumInteger32: null
PropertyMinimumInteger32: null
RequiresUniqueElements: false
Settability: READ_ONLY
TargetAccessRequired: READ

SecurityFolder Property



Indicates a Folder object from which the object inherits security (a security parent).

This value is indirectly set when DefineSecurityParentage is specified as the value of the defineSecurityParentage parameter for the Folder.file method. The value, in this case, is the folder in which the object is filed.

You can designate multiple security parents for an object by using one or more object-valued properties and setting the SecurityProxyType value for these properties to INHERITANCE.

Metadata

AllowsDefaultChange: false
Cardinality: SINGLE
CopyToReservation: true
DataType: OBJECT
DeletionAction: NONE
IsHidden: true
IsOrderable: true
IsSearchable: true
IsValueRequired: false
ModificationAccessRequired: WRITE_ACL
PersistenceType: OWN_COLUMN
ReflectiveProperty: null
RequiredClass: Folder
RequiresUniqueElements: false
Settability: READ_WRITE
TargetAccessRequired: LINK

SecurityParent Property



Deprecated. Use SecurityFolder instead.

Specifies the object from which a given object inherits security. The value of this property is a ReferentialContainmentRelationship (or DynamicReferentialContainmentRelationship) that represents the object from which security is inherited.

An object can inherit its permissions from its security parent. For example, a Document object can inherit the permissions of the Folder in which it is filed. A Folder object always inherits its permissions from its parent folder. An object's security parent is reflected in the value of its SecurityParent property. You can explicitly set the security parent of an object at the time it is filed into a folder by specifying the defineSecurityParentage parameter of the Folder.file method.

Metadata

AllowsDefaultChange: false
Cardinality: SINGLE
CopyToReservation: false
DataType: OBJECT
DeletionAction: NONE
IsHidden: true
IsOrderable: false
IsSearchable: false
IsValueRequired: false
ModificationAccessRequired: WRITE_ACL
PersistenceType: NOT_PERSISTENT
ReflectiveProperty: null
RequiredClass: ReferentialContainmentRelationship
RequiresUniqueElements: false
Settability: READ_WRITE
TargetAccessRequired: READ

SecurityPolicy Property



Specifies the SecurityPolicy associated with the given object. The SecurityPolicy contains one or more SecurityTemplate objects that define the permissions to assign to a given object. A security template can be one of two types: a VersioningSecurityTemplate or an ApplicationSecurityTemplate. A VersioningSecurityTemplate defines permissions that will be automatically assigned to the object when its version state changes. An ApplicationSecurityTemplate defines permissions that will be assigned to the object upon an explicit call to do so by an application program. For information on each of these types of templates, refer to their interface descriptions.

Assigning a security policy to a Document, CustomObject, or Folder object (or their subclasses) is optional.

Metadata

AllowsDefaultChange: true
Cardinality: SINGLE
CopyToReservation: true
DataType: OBJECT
DeletionAction: NONE
IsHidden: true
IsOrderable: true
IsSearchable: true
IsValueRequired: false
ModificationAccessRequired: WRITE_ACL
PersistenceType: OWN_COLUMN
ReflectiveProperty: null
RequiredClass: SecurityPolicy
RequiresUniqueElements: false
Settability: READ_WRITE
TargetAccessRequired: READ

This Property



The current object. The primary purpose of this property is to enable the expression of relationships among objects in a Content Engine query and to select candidate objects in the query results.

Metadata

AllowsDefaultChange: false
Cardinality: SINGLE
CopyToReservation: false
DataType: OBJECT
DeletionAction: NONE
IsHidden: true
IsOrderable: true
IsSearchable: true
IsValueRequired: true
ModificationAccessRequired: WRITE
PersistenceType: NOT_PERSISTENT
ReflectiveProperty: null
RequiredClass: Versionable
RequiresUniqueElements: false
Settability: READ_ONLY
TargetAccessRequired: READ

VersionSeries Property



Specifies a VersionSeries object that contains all of the document versions associated with this document or DynamicReferentialContainmentRelationship object.

Metadata

AllowsDefaultChange: false
Cardinality: SINGLE
CopyToReservation: false
DataType: OBJECT
DeletionAction: NONE
IsHidden: false
IsOrderable: true
IsSearchable: true
IsValueRequired: true
ModificationAccessRequired: WRITE
PersistenceType: OWN_COLUMN
ReflectiveProperty: Versions
RequiredClass: VersionSeries
RequiresUniqueElements: false
Settability: READ_ONLY
TargetAccessRequired: READ

VersionStatus Property



Specifies a VersionStatus constant that indicates the current version status of this document version.

The VersionStatus property can have one of the values in the following table.

Name Value Description
IN_PROCESS 2 Indicates an in-process document version. An in-process version is a version that has been checked in and is the latest minor version. Note that only one version at a time in a given version series can be in the IN_PROCESS state. When a reservation version is checked in as a minor version and becomes the new in-process version, the previous in-process version becomes a superseded version.
RELEASED 1 Indicates a released document version. A released version is a version that has been checked in and is the latest major version. Note that only one version at a time in a given version series can be in the RELEASED state.
RESERVATION 3 Indicates a reservation document version. A reservation version is a version that has been checked out.
SUPERSEDED 4 Indicates a superseded document version. A superseded version is a major or minor version that has been replaced by a later version.

Metadata

AllowsDefaultChange: false
Cardinality: SINGLE
CopyToReservation: false
DataType: LONG
IsHidden: false
IsOrderable: true
IsSearchable: true
IsValueRequired: true
ModificationAccessRequired: WRITE
PersistenceType: OWN_COLUMN
PropertyDefaultInteger32: null
PropertyMaximumInteger32: null
PropertyMinimumInteger32: null
RequiresUniqueElements: false
Settability: READ_ONLY
TargetAccessRequired: READ

Versions Property



Specifies a VersionableSet object that contains all of the document versions associated with this document or version series.

Metadata

AllowsDefaultChange: false
Cardinality: ENUM
CopyToReservation: false
DataType: OBJECT
DeletionAction: NONE
IsHidden: false
IsOrderable: false
IsSearchable: false
IsValueRequired: false
ModificationAccessRequired: WRITE
PersistenceType: OWN_COLUMN
ReflectiveProperty: null
RequiredClass: Versionable
RequiresUniqueElements: false
Settability: READ_ONLY
TargetAccessRequired: READ