Creates a new instance of a Checkout pending action object.


Namespace: FileNet.Api.Action
Assembly: FileNet.Api (in filenet.api.dll)

Syntax

Visual Basic (Declaration)
Public Sub New( _ 
   ByVal reservationId As String,  _ 
   ByVal reservationType As ReservationType,  _ 
   ByVal reservationClass As String,  _ 
   ByVal reservationProperties As IProperties _ 
)
C#
public Checkout(
   string reservationId,
   ReservationType reservationType,
   string reservationClass,
   IProperties reservationProperties
)
C++
public:
 Checkout(
   String reservationId,
   ReservationType reservationType,
   String reservationClass,
   IProperties reservationProperties
) sealed 
J#
public Checkout(
   string reservationId,
   ReservationType reservationType,
   string reservationClass,
   IProperties reservationProperties
)
JScript
public function Checkout(
   reservationId : String,
   reservationType : ReservationType,
   reservationClass : String,
   reservationProperties : IProperties
)

Parameters

reservationId
A String specifying a GUID to be assigned to the reservation object that is created when a document is checked out, thus overriding the reservation object's ID. An assigned ID can be useful if you need to later import a series of document versions. Use with caution. If null, the API generates a new GUID for the reservation object.
reservationType
A ReservationType constant specifying the type of checkout reservation: collaborative, exclusive, or the default object store setting (DefaultReservationType property). If null, the API uses the default object store setting.
reservationClass
A String specifying the symbolic name of the class to which a document's reservation object belongs. If null, the class of the reservation object remains the same as that of the checked-out document.
reservationProperties
A Properties object containing a list of property values to pre-assign to a document's reservation object. If null, no property values are pre-assigned to the reservation object.

See Also