Checkin / Checkout Document Ext

Function Name: getCheckinCheckoutExtXml

Class: com.newgen.dmsapi.DMSInputXml

Description: This call is used to perform CheckIn and CheckOut operations on the selected document. Operation that is to be performed is specified by the checkinCheckoutFlag. User can also set information about the carry forwarding of annotations when new Version is created. When a User CheckIns a document with a new Version, first a document is added to the Image Server and then the operation is performed. User has to specify the Image Index and Volume Index returned from the Image Server.

Input Parameters	Sample InputXML
Output Parameters	Sample OutputXML
View xml API::CheckinCheckoutExtXml

Prototype:

public String getCheckinCheckoutExtXml(String cabinetName, String userDBId,

String currentDateTime, String limitCount,

String checkInOutFlag, String supAnnotVersion,

String documentList)

Input Parameters:

Name	Description	Valid Values	Default Values
CabinetName	Name of the Cabinet to which the User wants to connect.	The name of the Cabinet.	N/A
UserDBId	UserDatabase ID, which is returned in the NGOConnect Cabinet call.		N/A
CurrentDateTime	The Date and Time at which the documents are being checked out/checked in.	Valid Date in the format- yyyy-mm-dd hh:mm:ss	The current Date and Time.
LimitCount	Maximum number of Versions that can be created for the document used only for CheckIn operation.	Integer >= 0	NULL
CheckInOutFlag	Specifies the desired type of operation. For example, CheckIn, CheckOut and undo CheckOut	‘N’ - CheckIn ‘Y’ – CheckOut ‘U’ – undo	N/A
SupAnnotVersion	Specifies whether the Annotations on the previous Version are to be suppressed or not.	‘Y’ – Yes ‘N’ – No	‘N’
documentList	List of the documents to be checked out which can be obtained from getCheckinCheckoutIndexList call. This function is called for each document to be checked in or checked out.

Output Parameters:

Input Xml of call NGOCheckinCheckoutExtXml.