Get Data Definition List

 

Function Name: getGetDataDefListExtXml

 

Class: com.newgen.dmsapi.DMSInputXml

 

Description: This function is used to get the List of all the Data Definitions available in the Cabinet. The Data Definitions can be fetched and sorted on Name or Index. Sorting can be done on ascending or descending order. The Data Class Lists are fetched in batches. User has to specify the Previous index value and Previous sort field value. The function returns the total number of Data Definitions in the System and the number of Data Definitions fetched in the current batch

 

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

 

Prototype:

public String getGetDataDefListExtXml(String cabinetName, String userDbId,

String orderBy, String sortOrder,

String prevIndex, String lastSortField,

String noOfRecordsToFetch, String type,

String groupId, String flag);

Overloaded functiions:

public String getGetDataDefListExtXml(String cabinetName, String userDbId,

String orderBy, String sortOrder,

String prevIndex, String lastSortField,

String noOfRecordsToFetch, String type,

String groupId);

 

Input Parameters:

Name	Description	Valid Values	Default Behaviour
cabinetName	Name of the Database Cabinet to which the User wants to connect.		N/A
userDBId	UserDatabase ID, which is returned in the ConnectCabinet call.		N/A
orderBy	Indicates the Order in which the List is returned. It can be either on Name or Index.	‘1’- Index, ‘2’-Name
sortOrder	Sorting Order of the Indexed field.	‘A’-Ascending ‘D’-Descending	A
previousIndex	The Index of the last Record of the previous batch.	Integer >= 0	0
lastSortField	The value of the sorted Column of the last Data Class received in the previous batch.	Depends upon the index field type.
NoOfRecordsToFetch	Number of Records to be fetched.	Integer >= 1	500
Type	Type of Data Class.	ACT (Reserved) or Blank	Blank
groupId	Group Id of the Cabinet.	Integer >= 1	0
flag	Flag indicates whether to get the Data Class associated with document, folder or both.	F, D, B, *	*(Fetch all)

 

Output Parameters:

An inputXml string of the NGOGetDataDefListExt call.