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. |
![]() |
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 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
|
![]() |
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
|
![]() |
CreateAnnotation | Creates and associates a new annotation to a specific content element of this document. To persist the created object to the object store, you must explicitly call its method, which will also cause the server to add it to the 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 property is set to ). To successfully demote a document, the following requirements must be met or an error will occur:
After a successful call to
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 call, the property of the object representing the document version is set to . An error is generated if this document is a reservation object ( = ) or is already a frozen version ( = ). |
![]() |
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 property is set to ). To successfully promote a document, the following requirements must be met or an error will occur:
After a successful call to
In addition, the Content Engine performs the following steps on the previous major document version that is being superseded:
|