Get List of Folders

 

Function Name:  getGetFolderListExtXml

 

Class: com.newgen.dmsapi.DMSInputXml

 

Description: This function is used to get the list of the Folders available in the Cabinet. The folders can be fetched sorted on Name or Index. Sorting can be done on ascending or descending order. The Folder List fetched is in batches. User has to specify the Previous index value and Previous sort field value.

 

Input Parameters

Sample InputXML

Output Parameters

Sample OutputXML

View xml API::NGOGetFolderListExt

  

 

Prototype:

public String getGetFolderListExtXml( String cabinetName, String userDbId,

                                                                     String currentDateTime, String folderIndex,

                                                                     String startPos,

                                                                     String noOfRecordsToFetch, String orderBy,

                                                                     String dataAlsoFlag, String recursiveFlag,

                                                                     String sortOrder, String lastSortField,

                                                                     String previousIndex, String accesstype,

                                                                     String folderType, String countFlag)

 

Overloaded Function:

public String getGetFolderListExtXml( String cabinetName, String userDbId,

String currentDateTime, String folderIndex,

String startPos, String lastSortField,

String noOfRecordsToFetch, String orderBy,

String dataAlsoFlag, String recursiveFlag,

String sortOrder, String AccessType,

String strFolderType)

  

Input Parameters:

Name

Description

Valid Values

Default Behavior

cabinetName

Name of the Database Cabinet to which the User wants to connect.

 

N/A

userDbId

UserDatabase ID, which is returned after the execution of getConnectCabinetXml call.

 

N/A

currentDateTime

Current Date and time.

Valid Date and Time in the format yyyy-mm-dd hh:mm:ss

Current Date and Time

folderIndex

Index of the Folder whose Folder List is to be fetched in this call. If it is 0, then list of all the folders is fetched.

 

Integer >= 0

0

startPos

This tag is meant for the last Index of the Folder received in the previous batch. 0 Should be sent for the first batch.

Integer >= 0

0

lastSortField

This tag is meant for the value of the sorted column of the last Folder received in the previous batch.

Depends upon the value of previous batch’ last object on which short was done.

null

noOfRecordsToFetch

Specifies the Number of Records to be fetched in the current batch.

Integer > 0

50

orderBy

Indicates the field on which the Folder List will be sorted. For example, Folder Name, Folder Index etc.

1- Folder Index 2- Folder Name

1

dataAlsoFlag

Specifies whether the Data Class field values associated with a folder will also be returned or only the associated Data Class will be returned.

‘Y’- Yes

‘N’ – No

‘N’

recursiveFlag

Indicates whether subfolders of folders should also be fetched recursively or not.

‘Y’- Yes

‘N’ – No

‘N’

SortOrder

Indicates whether Folder List is to be sorted in Ascending order or Descending order.

‘A’ – Ascending

‘D’ –Descending

‘A’

AccessType 

This parameter specifies whether the intended folders are having access type as private, shared or inherited. 

S/I/P 

S 

FolderType 

This parameter specifies whether the folders are of type General,Sent Items,Inbox,Trash,A 

G/S/I/T/A 

G 

countFlag

Specifies whether to retrieve the count of folder or not.

‘Y’- yes

‘N’ – No

'Y'

previousIndex

This tag is meant for the last Index of the Folder received in the previous batch. Should be sent for the first batch.

Integer>=0

0

 

Output Parameters:

An InputXml string of the NGOGetFolderListExt call.