Function Name: getCheckInCheckOutIndexList
Class: com.newgen.dmsapi.DMSInputXml
Description: This function is used to generate List of Action Ids.
Prototype:
|
public String getCheckInCheckOutIndexList |
( |
|
|
|
|
String documentIndex, String ISIndex |
|
|
|
String versionComment, |
|
|
|
String documentType, String noOfPages |
|
|
|
String documentSize, |
|
|
|
String createdByAppName |
|
|
) |
|
|
Name |
Description |
Valid Values |
Default Behaviour |
|
DocumentIndex |
Document Index of the document being checked out/checked in. |
Integer >=0 |
N/A |
|
ISIndex |
Specifies a unique Combination of Image Index and Volume Index for a document added to the Image Server before making this call. Its format is Image Index and Volume Index separated by #. For example, 3#79. It is used for CheckIn operation only. |
|
|
|
VersionComment |
Comments for new Version of the document. This is used only for CheckIn operation. |
Text |
NULL |
|
documentType |
Type of document being checked out/checked in This is used only for CheckIn operation. |
‘I’ – Image ‘N’ – Non Image |
N/A |
|
noOfPages |
Number of pages in the document being checked in. This is used only for CheckIn operation. |
Integer >= 1 |
N/A |
|
documentSize |
Size (in bytes) of the document being checked in. This is used only for CheckIn operation. |
Integer > 0 |
N/A |
|
createdByAppName |
Extension of document being checked out/checked in. This is used only for CheckIn operation. |
Extension of the document. |
N/A |
<Document>
<DocumentIndex>6</DocumentIndex>
<ISIndex>2#4</ISIndex>
<VersionComment>Changes</VersionComment>
<DocumentType>I</DocumentType> // for Checkin only
<NoOfPages>45</NoOfPages> // for Checkin only
<DocumentSize>32</DocumentSize> // for Checkin only
<CreatedByAppName>bmp</CreatedByAppName> // for Checkin only
</Document>