VersionSeries Properties

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

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: false
IsSearchable: false
IsValueRequired: true
ModificationAccessRequired: WRITE
PersistenceType: NOT_PERSISTENT
ReflectiveProperty: null
RequiredClass: ClassDescription
RequiresUniqueElements: false
Settability: READ_ONLY
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: false
IsOrderable: false
IsSearchable: false
IsValueRequired: false
ModificationAccessRequired: WRITE
PersistenceType: NOT_PERSISTENT
ReflectiveProperty: null
RequiredClass: Versionable
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: false
IsSearchable: false
IsValueRequired: true
ModificationAccessRequired: WRITE
PersistenceType: OWN_COLUMN
RequiresUniqueElements: false
Settability: SETTABLE_ONLY_ON_CREATE
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: false
IsSearchable: false
IsValueRequired: true
ModificationAccessRequired: WRITE
PersistenceType: NOT_PERSISTENT
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: false
Cardinality: SINGLE
CopyToReservation: false
DataType: BOOLEAN
IsHidden: false
IsOrderable: false
IsSearchable: false
IsValueRequired: true
ModificationAccessRequired: WRITE
PersistenceType: NOT_PERSISTENT
PropertyDefaultBoolean: true
RequiresUniqueElements: false
Settability: READ_ONLY
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: false
IsOrderable: false
IsSearchable: false
IsValueRequired: false
ModificationAccessRequired: WRITE
PersistenceType: NOT_PERSISTENT
ReflectiveProperty: null
RequiredClass: Versionable
RequiresUniqueElements: false
Settability: READ_ONLY
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

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: false
IsSearchable: false
IsValueRequired: true
ModificationAccessRequired: WRITE
PersistenceType: NOT_PERSISTENT
ReflectiveProperty: null
RequiredClass: VersionSeries
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: VersionSeries
RequiredClass: Versionable
RequiresUniqueElements: false
Settability: READ_ONLY
TargetAccessRequired: READ

WorkflowSubscriptions Property



The InstanceWorkflowSubscriptionSet object containing the InstanceWorkflowSubscription objects whose target is 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: SubscriptionTarget
RequiredClass: InstanceWorkflowSubscription
RequiresUniqueElements: false
Settability: READ_ONLY
TargetAccessRequired: READ