Represents the complete set of versions for a versionable object, or document (that is, an object instantiated from a subinterface of the IVersionable interface). Because a VersionSeries object is constructed by the server from versionable objects and does not have its state stored in a database, it is read-only, and thus you cannot modify any of its properties. In addition, a VersionSeries object has no security attached to it; it is secured by the current document version associated with it. You can access a specific document version by navigating through the collection returned by the Versions property. Use extreme caution when deleting a VersionSeries object; if you delete it, all of its associated document versions will also be deleted.


The following tables list the members exposed by IVersionSeries.

Public Properties

  Name Description
Public property AuditedEvents An EventSet collection of the Event objects containing the audited events that have occurred for the object.
Public property CurrentVersion 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.
Public property Id 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 IUser and IGroup 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, IUser.Id and IGroup.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:

  • PropertyDescription.Id is equal to PropertyTemplate.Id, which is equal to PropertyDefinition.PrimaryId.
  • PropertyDefinition.Id is not equal to PropertyDefinition.PrimaryId.
  • PropertyDefinition.Id is not equal to PropertyDescription.Id.

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.

Public property IsReserved For a Document object, specifies whether a user has reserved the right to check in the next version following this document 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).
Public property IsVersioningEnabled Specifies whether you can create a new version of this object (True) or not (False).
Public property ReleasedVersion 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.
Public property Reservation 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.
Public property Versions Specifies a VersionableSet object that contains all of the document versions associated with this document or version series.
Public property WorkflowSubscriptions The IInstanceWorkflowSubscriptionSet object containing the IInstanceWorkflowSubscription objects whose target is this object.
Top

Public Methods

  Name Description
Public method CancelCheckout Cancels the check-out reservation held on this document or version series by deleting the reservation object associated with it. Any changes made to the reservation object are lost. If the reservation object is an exclusive reservation (the object's ReservationType property is set to EXCLUSIVE), the user must be the reservation owner (the reservation owner's name is the value of the reservation object's Owner property) or have both WRITE_OWNER and DELETE access rights. Note that this method is provided only as a convenience method for canceling a checkout; all it does is delete the reservation version held by the document or version series from which it is called.

After a document's reservation object is deleted, the Content Engine performs the following steps on the reserved document version:

  • Sets the IsReserved property to false.
  • Sets the ReservationType property to null.

An error occurs if the document is not checked out or is a newly created object that has never been checked in.

Public method Checkout Creates a reservation object that can be modified and checked in as a new version of this document. The reservation object can be accessed from this document's Reservation property. You can either specify the type of checkout reservation (exclusive or collaborative) or use the default checkout reservation setting of the object store.

To successfully check out a document, the following requirements must be met or an exception will be thrown:

  • The document must be the current version (IsCurrentVersion property is set to true).
  • The document must not already be checked out (IsReserved property is set to false).
  • The document must be version-enabled (IsVersioningEnabled property is set to true).
  • The user must have the appropriate access rights (MINOR_VERSION to check out a minor version, or MAJOR_VERSION to check out a released version).

After a successful call to Checkout, the Content Engine performs the following steps:

  • Applies the versioning security template for the reservation state (if it exists and is enabled) to the newly created reservation object.
  • Sets the IsReserved property of the checked-out document to true.
  • Sets the ReservationType property of the checked-out document to the appropriate setting: (COLLABORATIVE or EXCLUSIVE).
Public method MoveContent Moves the content data of an object to a new storage area.
Top

See Also