Function Name: getGetAllAlarmsXml
Class: com.newgen.dmsapi.DMSInputXml
Description: This function is used to fetch all the Alarms set by a User or set for a User on the basis of a flag. If GetAllForUser flag is Y, then all the Alarms set for the logged in User are returned, otherwise, all Alarms set by the logged in User are returned.
Input Parameters Sample InputXML
Output Parameters Sample OutputXML
Prototype:
public String getGetAllAlarmsXml (
String cabinetName,
String userDbId,
String getAllForUser,
String documentType,
String objectType,
String objectIndex,
String informMode,
String alarmCountOnly
)
public String getGetAllAlarmsXml (
String cabinetName,
String userDbId,
String getAllForUser,
String documentType,
String objectType,
String objectIndex,
String informMode,
String alarmCountOnly,
String alarmGenerated,
String targetUserIndex,
String lastAlarmIndex,
String noOfRecordsToFetch,
String sortOrder,
)
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 in the ConnectCabinet call. |
|
N/A |
|
getAllForUser |
Indicates whether Alarms set for the User or set by the User are to be obtained. |
‘Y’- Set for User ‘N’- Set by User |
Both the types of Alarms – those set by and for the User, will be fetched. |
|
documentType |
It specifies the Type of document. |
I – Image N – Non Image A – Reserved |
Alarms for all types of documents will be fetched. |
|
objectType |
It indicates the Type of Object. |
D-Document F-Folder |
D |
|
objectIndex |
The Index of the Object for which the Alarm had been set. |
|
N/A |
|
informMode |
Reserved for internal use. |
Null |
|
|
alarmCountOnly |
Flag, which specifies whether the details about all the Alarms are required. |
N – Gives the complete details about all the Alarms. Y – Does not give the actual details of the Alarms but gives the count only for the Alarms. |
N |
|
alarmGenerated |
Whether the alarm has been previously generated or not. |
Y or N |
Y |
|
targetUserIndex |
Index of the target user for which this alarm has been set. |
Integer |
|
|
LastAlarmIndex |
Index of the last alarm in the previous batch of alarms fetched. |
|
|
|
NoOfRecordsToFetch |
No of Maximum records to be fetched from the database. |
|
|
|
SortOrder |
This tells whether the list to be fetched in ascending or descending order. |
A/D |
|
Output Parameters:
An Input Xml for NGOGetAllAlarms.