Function
Name:
getGetPendingRemindersXml
Class:
com.newgen.dmsapi.DMSInputXml
Description: This function returns the List of Reminders set by or for
the logged in User based on
GetAllForUser flag. All the Reminders can be fetched at a time or they can be
fetched in batches, either in ascending or descending order of Date.
|
Prototype:
public String
getGetPendingRemindersXml |
( |
|
|
|
String cabinetName,
|
|
|
String userDBId, |
|
|
String
currentDateTime, |
|
|
String
getAllForUser, |
|
|
String docType, |
|
|
String
documentIndex, |
|
|
String
lastReminderIndex, |
|
|
String sortOrder, |
|
|
String userIndex, |
|
|
String
noOfRecordsToFetch, |
|
|
String informMode, |
|
|
String
ReminderCountOnly |
|
) |
|
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 |
currentDateTime |
It indicates the
current Date and Time on the Server. |
|
CurrentDate Time. |
getAllForUser |
Specifies whether
the Alarms and Reminders set for User or set by the User who has logged in
are to be considered. |
'S' – All Reminders
Set by the currently logged in User irrespective of Date / Time. 'A' - All Reminders set for the currently
logged in User irrespective of Date / Time. 'T' - All the Reminders, before the specified
Time, set for the currently logged in User. 'B' – All the
Reminders in Batches, before the specified Time, set for the currently logged
in User. |
T |
docType |
It indicates the
Type of the document. |
I – Image N – Non Image A –Reserved |
NULL |
documentIndex |
The Index of the
document for which Reminders are set. |
Integer >=0 |
N/A |
lastReminderIndex |
It indicates the
Index of the last Reminder in the Previous batch. |
|
|
sortOrder |
It indicates the
Order in which Reminders are fetched. |
A – Ascending D – Descending |
A |
userIndex |
It indicates the
Index of the User for whom Reminders are fetched. |
Integer >=0 |
Logged in User’s
Index. |
NoOfRecordsToFetch |
The number of
Records to be fetched for the call. |
Integer>0 |
10 |
informMode |
Specifies the
manner in which the User is to be notified about an Alarm / Reminder. |
P - Popup M – Mail B – Both |
B |
reminderCountOnly |
It is a flag to
indicate whether the OutputXML will bring the Reminder Count only or the
details of the Reminders also. |
|
N |
An Input Xml for
NGOGetPendingReminders.