Function Name: getGetGlobalIndexListXml
Class: com.newgen.dmsapi.DMSInputXml
Description: This function is used to get the List of all the Global Indexes available in the Cabinet. The Global Indexes Lists can also be fetched in batches. User has to specify startFrom and noOfRecordsToBeFetched. The call returns the total number of Global Indexes in the System and the number of Global Indexes fetched in the current batch.
The User can specify the IndexFlag to get the Global Indexes for that particular scope (i.e., ‘G’ Global or ‘D’ Data type). User can specify the IndexType to get the Global Indexes for that particular type (i.e., Integer, Boolean, Date, Float, Long, String, Text, X (document index), *(all)).
|
|
Prototype:
|
public String getGetGlobalIndexListXml |
( |
|
|
|
|
String cabinetName, String userDbId, |
|
|
|
String globalOrDataFlag,String docIdOnly, |
|
|
|
String orderBy , String sortOrder, |
|
|
|
String prevIndex, String lastSortField, |
|
|
|
String noOfRecordsToFetch, |
|
|
|
String IndexFlag, String IndexType, |
|
|
|
String startPos |
|
|
} |
|
OverLoaded Functions:
|
public String getGetGlobalIndexListXml |
( |
|
|
|
|
String cabinetName, String userDbId, |
|
|
|
String globalOrDataFlag,String docIdOnly, |
|
|
|
String orderBy , String sortOrder, |
|
|
|
String prevIndex, String lastSortField, |
|
|
|
String noOfRecordsToFetch |
|
|
) |
|
|
public String getGetGlobalIndexListXml |
( |
|
|
|
|
String cabinetName, String userDbId, |
|
|
|
String IndexFlag, String IndexType, |
|
|
|
String startPos, String noOfRecordsToFetch |
|
|
) |
|
|
Name |
Description |
Valid Values |
Default Behaviour |
|
cabinetName |
Name of the Database Cabinet to which the User wants to connect. |
|
|
|
userDBId |
UserDatabase ID, which is returned after the execution of getConnectCabinetXml call. |
|
|
|
indexFlag |
Global Indexes for that particular scope (i.e., ‘G’ Global or ‘D’ Data type). |
‘G’ Global, ‘D’ Data type, *(all). |
*(all). |
|
indexType |
Global Indexes for that particular Type. |
Integer, Boolean, Date, Float, Long, String, Text, X (docid), *(all)) |
*(all). |
|
startPos |
It is an integer that specifies the starting number from where the Records in the Results have to be fetched. |
Integer>=0 |
0 |
|
noOfRecordsToFetch
|
It is an integer, which specifies the number of Records that has to be fetched in a batch. |
Integer>0 |
Batch Size set at server end |
Input Xml of call NGOGetGlobalIndexList.