Function Name: getCheckinCheckoutExtXml
Class: com.newgen.dmsapi.DMSInputXml
Description: This function does the CheckIn and CheckOut functionality for the documents. Once a document is Checked Out, no other User, other than the one who has Checked Out, can modify the Property of the document. Other Users can modify the document only when it has been checked in.
|
|
Prototype:
public String getCheckinCheckoutExtXml(String cabinetName, String userDBId,
String currentDateTime, String limitCount,
String checkoutFlag,
String supAnnotVersion,
String documentList)
|
Name |
Description |
Valid Values |
Default Behavior |
|
cabinetName |
Name of the Database Cabinet to which the User wants to connect. |
The name of the Cabinet. |
N/A |
|
UserDBId |
UserDatabse ID, which is returned in the ConnectCabinet 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. |
|
checkInOutFlag |
Specifies the desired Type of operation namely, CheckIn, CheckOut, undo CheckOut. |
‘N’ - CheckIn ‘Y’ – CheckOut ‘U’ – undo CheckOut |
N/A |
|
LimitCount |
The number of CheckIns / CheckOuts to limit. |
Integer >= 0 |
NULL |
|
supAnnotVersion |
Specifies whether the Annotations on the previous Version are to be suppressed or not. |
‘Y’ – Yes ‘N’ – No |
‘N’ |
|
documentList |
XML of the document List to be checked in or out. |
Valid XML |
N/A |
Input Xml of call NGOCheckinCheckoutXml.