System.Object
CheckoutAction
Client Declaration
public class CheckoutAction
Represents a pending action for checking out a document. When a document is checked out, the Content Engine creates a new reservation document object that can be modified and checked in as a new version of the document. This reservation object can be accessed from the original document's Reservation
property. For more information, see the Java™ API Checkout
class and checkout
method topics.
Elements
ModifiedPropertiesType
ReservationProperties
: [request] Optional element specifying the collection of the checked-out document's property values that will be carried over to its associated reservation object, thus allowing you to modify them. When a reservation object is checked in, its existing property values and any property values that you have modified will be carried over to the new document version that is created by the server.Attributes
String
reservationClass
: [request] Optional expression specifying, either by symbolic name or GUID, the class to which the checked-out document's associated reservation object will belong. Thus, this attribute allows you to specify the class of the new document version that will be created when the reservation object is checked in. If this attribute is not specified, the reservation object's class will be the same as the checked-out document's class.GuidType
reservationId
: [request] Optional expression specifying a new GUID string to be assigned to the reservation Document
object created by CheckoutAction
,
thus overriding its original ID.ReservationType
reservationType
: [request] Optional expression specifying the type
of reservation to be created: collaborative or exclusive. Attributes Specific to .NET Clients
reservationTypeSpecified
: Optional expression specifying whether reservationType
has a value (true
) or not (false
).
CheckoutAction objCheckout = new CheckoutAction(); objCheckout.reservationType = ReservationType.Exclusive;
<xsd:complexType name="CheckoutAction"> <xsd:complexContent> <xsd:extension base="ActionType"> <xsd:sequence> <xsd:element minOccurs="0" name="ReservationProperties" type="ModifiedPropertiesType"/> </xsd:sequence> <xsd:attribute name="reservationId" type="GuidType"/> <xsd:attribute name="reservationType" type="ReservationType"/> <xsd:attribute name="reservationClass" type="xsd:string"/> </xsd:extension> </xsd:complexContent> </xsd:complexType>