Get Alarm Reminder Count

 

Function Name: getAlarmReminderCount

 

Class: com.newgen.dmsapi.DMSInputXml

 

Description: This function is used to fetch the number of Alarms and Reminders that are generated for the logged in User, based on GetAllForUser and SetforUser flags. All Reminders can be fetched at a time or they can be fetched in batches.

 

 

Input Parameters

Sample InputXML

Output Parameters

Sample OutputXML

View xml API::NGOGetAlarmReminderCount

  

 

Prototype:

 

public String getAlarmReminderCount

(

 

 

 

String cabinetName,

 

 

String userDbId,

 

 

String currentDateTime,

 

 

String getAllForUser,

 

 

String alarmGenerated,

 

 

String userIndex,

 

 

String documentType,

 

 

String informMode,

 

 

String setForUser,

 

 

String objectType,

 

 

String objectIndex,

 

 

String countType

 

)

 

 

Overloaded Function:

public String getAlarmReminderCount (

                                                                  String cabinetName,

                                                                  String userDbId,

                                                                  String currentDateTime,

                                                                 String getAllForUser,

                                                                 String alarmGenerated,

                                                                 String userIndex,

                                                                 String documentType,

                                                                 String informMode,

                                                                 String setForUser,

                                                                String objectType,

                                                                String objectIndex,

                                                                String countType

                                                                String flatReminderAlso

                                                       )

 

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

currentDateTime

Current Date and Time at which the call is made to the Server.

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

Current Date and Time of the Server.

setForUser

It is a flag used for fetching Alarms, which are set for the User or set by the User.

Y Set for User, N Set by User

N

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 currently logged in User irrespective of Date / Time

'A'  - All Reminders set for currently logged in User irrespective of Date / Time

'T'  - All the Reminders, before the specified Time, set for currently logged in User.

'B' - All the Reminders in Batches, before given time, set for currently logged in User.

 T

alarmGenerated

It is a flag, which indicates whether the Alarms have been generated, or not.

 

 Y – Alarm is generated.

N – Alarm not Generated.

 

 

userIndex

The Index of the User for whom the Alarm has been set.

 

 

documentType

It Specifies the Type of the document.

I – Image

N – Non Image

A – Reserved

 

informMode

(Reserved)

null

 

objectIndex

The Index of the Object for which the Alarm has been set.

 

N/A

objectType

It indicates the Type of Object.

D-Document

F-Folder

D

countType

Flag, which specifies whether the count is for Alarms or Reminders or both.

Reminder, Alarms and Both

 

B-Both.

flatReminderAlso

It is a flag to indicate whether the count for  general reminders is also to be fetched or not.

Y–To be fetched  N-Not

Y

 

Output Parameters:

An Input Xml for NGOGetAlarmReminderCount.