Represents the complete set of versions for a versionable object, or document (that is, an object instantiated from a subinterface of the
interface). Because a
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
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
property. Use extreme caution when deleting a
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 | |
---|---|---|
![]() |
AuditedEvents | An collection of the objects containing the audited events that have occurred for the object. |
![]() |
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. |
![]() |
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 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 |
![]() |
IsReserved | For a object, specifies whether a user has reserved the right to check in the next version following this document version ( ) or not ( ). For a object, specifies whether the current version in this version series is checked out ( ) or not ( ). |
![]() |
IsVersioningEnabled | Specifies whether you can create a new version of this object ( ) or not ( ). |
![]() |
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 property value of . Note that only one document version at a time in a given version series can be in the released state. |
![]() |
Reservation | Specifies the reservation object of this object's version series, which has a property value of . 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. |
![]() |
Versions | Specifies a object that contains all of the document versions associated with this document or version series. |
![]() |
WorkflowSubscriptions | The IInstanceWorkflowSubscriptionSet object containing the IInstanceWorkflowSubscription objects whose target is this object. |
Public Methods
Name | Description | |
---|---|---|
![]() |
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 property is set to ), the user must be the reservation owner (the reservation owner's name is the value of the reservation object's property) or have both and 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:
An error occurs if the document is not checked out or is a newly created object that has never been checked in. |
![]() |
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 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:
After a successful call to
|
![]() |
MoveContent | Moves the content data of an object to a new storage area. |