Function Name: getGetDocumentPropertyXml
Class: com.newgen.dmsapi.DMSInputXml
Description: This function retrieves the Property of the document. User can specify whether the data related to the associated Data Class has to be fetched or not. This call also gives information about Global Indexes and Thumbnail.
|
|
Prototype:
public String getGetDocumentPropertyXml( String cabinetName, String userDbId,
String creationDateTime,
String docIndex,
String dataAlsoFlag,String versionNo,
String parentFolderIndex, String thumbNailAlsoFlag
)
OverLoaded Functions:
public String getGetDocumentPropertyXml( String cabinetName, String userDbId,
String creationDateTime,
String docIndex,
String dataAlsoFlag,String versionNo)
|
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 |
UserDatabase ID, which is returned after the execution of getConnectCabinetXml call. |
|
N/A |
|
currentDateTime |
The Date and Time at which the Document Properties are being retrieved. |
Valid Date in the format- yyyy-mm-dd hh:mm:ss |
The current Date and Time. |
|
documentIndex |
The Document Index of the document whose Properties are to be retrieved. |
Integer >=0 |
N/A |
|
DataAlsoFlag |
Signifies whether the values of the data fields of the associated Data Class have to be fetched with the document. |
‘Y’ – Yes ‘N’ – No |
‘N’ |
|
VersionNo |
The Version of the document whose Properties are to be retrieved. |
X. Y where X>=1 and Y>=0 |
Current Version |
|
ParentFolderIndex |
The Folder Index of the folder in which this document is present. |
Integer >=0 |
NULL |
|
ThumbNailAlsoFlag |
Specifies whether the Thumbnails of all the pages of the document are to be retrieved or not. |
‘Y’ – Yes ‘N’ – No |
‘N’ |
Input Xml of call NGOGetDocumentPropertyXml.