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
Creator
property) or have both
WRITE_OWNER
and
DELETE
access rights. Regardless of whether the reservation object is an exclusive or a collaborative reservation, the user must also have appropriate access rights on the reservation object (
MINOR_VERSION
or
MAJOR_VERSION
) to cancel the checkout.
Note |
---|
Calling this method is effectively the same as deleting a reserved document's reservation object. |
After a successful call to CancelCheckout
, the Content Engine performs the following steps on the reserved document version and deletes its reservation object:
- 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.
Namespace: FileNet.Api.CoreAssembly: FileNet.Api (in filenet.api.dll)
Syntax
Visual Basic (Declaration) |
---|
Function CancelCheckout() As IVersionable |
Return Value
A Versionable
object specify the reservation object for which a delete pending action has been created.
See Also