public class Checkout extends PendingAction
checkout
method, the API automatically creates an instance of the Checkout
class and adds it to the underlying object's collection of PendingAction
objects.Constructor and Description |
---|
Checkout(java.lang.String reservationId,
ReservationType reservationType,
java.lang.String reservationClass,
Properties reservationProperties)
Creates a new instance of a
Checkout pending action object. |
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getReservationClass()
Returns the symbolic name of the class to which a reservation object belongs.
|
java.lang.String |
getReservationId()
Returns the GUID assigned to a reservation object.
|
Properties |
getReservationProperties()
Returns a list of property values belonging to a document's reservation object.
|
ReservationType |
getReservationType()
Returns the type of checkout reservation.
|
getBinaryListValue, getBinaryValue, getBooleanListValue, getBooleanValue, getDateTimeListValue, getDateTimeValue, getEngineObjectValue, getFloat64ListValue, getFloat64Value, getIdListValue, getIdValue, getInteger32ListValue, getInteger32Value, getObjectValue, getStringListValue, getStringValue, putObjectValue, putValue, putValue, putValue, putValue, putValue, putValue, putValue, putValue, putValue, putValue, putValue, putValue, putValue, putValue, putValue, toString
public Checkout(java.lang.String reservationId, ReservationType reservationType, java.lang.String reservationClass, Properties reservationProperties)
Checkout
pending action object.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 a new class for the
reservation object. 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
the reservation object. If null
, no property values are pre-assigned to the reservation object.E_NOT_SUPPORTED
- if versioning is not enabled (IsVersioningEnabled = false
) or the document
is not the current version (IsCurrentVersion = false
). Thrown when you call the save
method.E_RESERVATION_EXISTS
- if the document is already reserved (IsReserved = false
). Thrown when you call the save
method.E_BAD_PARAMETER
- if reservationId is not a GUID. Thrown when you call the save
method.E_BAD_OBJECT
- if reservationClass is not the same object type as the class of the checked-out document.
Thrown when you call the save
method.public java.lang.String getReservationId()
String
specifying a GUID.public ReservationType getReservationType()
ReservationType
constant specifying the type of checkout reservation.public java.lang.String getReservationClass()
String
specifying the symbolic name of the class.public Properties getReservationProperties()
Properties
object containing a list of property values.© Copyright IBM Corporation 2006, 2015. All rights reserved.