The IVersionable type exposes the following members.
Methods
Type | 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 ReservationType
property is set to EXCLUSIVE), only the user who checked out the document can cancel the check out,
or must 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:
An error occurs if the document is not checked out or is a newly created object that has never been checked in. |
![]() | ChangeClass |
Changes the class of a Content Engine object. The new class must already exist and both it and the
original class must be subclasses of the same base class.
The ChangeClass method does not modify the security for an object, even if the object's current security
is derived from the default security for its source class. For the object's user-defined properties,
the following rules apply:
When the class of a document object is changed, the default document lifecycle policy of the new class will only be applied to the document object's DocumentLifecyclePolicy property if both of the following scenarios occur:
Changing the document class of a document object has no effect on the storage location of the document’s content. For more information, see the Document Storage topic in the "Document Concepts" section of the Content Engine Java and .NET API Developer’s Guide. |
![]() | 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:
After a successful call to Checkout, the Content Engine performs the following steps:
|
![]() | CreateAnnotation |
Creates and associates a new annotation to a specific content element of this document.
This is a convenience method for creating an Annotation object from the document. You can also create an Annotation directly
using the Factory.Annotation.createInstance() method, and then setting the AnnotatedObject property with the object on which
the Annotation is placed.
To persist the created Annotation object to the object store, you must explicitly call its Save method, which will also cause the server to add it to the Annotations collection of this document. |
![]() | DemoteVersion |
Demotes the latest major version of this document to an unreleased minor version. This method changes the previous
major version (if it exists) to the current released major version, but does not delete any document versions (including content)
from the document's version series, therefore allowing you to continue to have access to all version changes.
Note that you can demote frozen document versions and documents that are not versioning-enabled
(documents whose IsVersioningEnabled property is set to false).
To successfully demote a document, the following requirements must be met or an error will occur:
After a successful call to demoteVersion, the Content Engine performs the following steps on the document version that is being demoted:
In addition, the Content Engine performs the following steps on the previous major document version:
|
![]() | Freeze |
Prevents changes to the custom properties of this document version. You can freeze any checked-in document version, but you cannot
freeze a reservation object. Once a document version has been frozen, it cannot be unfrozen; to change a frozen document's custom properties,
a new document version must be created. Note, however, that you can change a document version's writable system properties at any time. After
a successful Freeze call, the IsFrozenVersion property of the object representing the document version is set to true.
An error is generated if this document is a reservation object (VersionStatus = RESERVATION) or is already a frozen version (IsFrozenVersion = true).
|
![]() | PromoteVersion |
Promotes an unreleased minor version of this document to a released major version. This method changes the current
released major version (if it exists) to a superseded major version, but does not delete any document versions (including content)
from the document's version series, therefore allowing you to continue to have access to all version changes.
Note that you can promote frozen document versions and documents that are not versioning-enabled
(documents whose IsVersioningEnabled property is set to false).
To successfully promote a document, the following requirements must be met or an error will occur:
After a successful call to PromoteVersion, the Content Engine performs the following steps on the document version that is being promoted:
In addition, the Content Engine performs the following steps on the previous major document version that is being superseded:
|