com.remedy.arsys.api
Class AlertMessageInfo

java.lang.Object
  com.remedy.arsys.api.AlertMessageInfo

public class AlertMessageInfo

extends java.lang.Object

The AlertMessageInfo class is used to decode a formatted alert message and return its component parts, for example, timestamp, source type, and so on.

Constructor Summary

AlertMessageInfo()
Default constructor

AlertMessageInfo(Timestamp time, int type, int prior, java.lang.String text, java.lang.String tag, java.lang.String svrName, java.lang.String form, java.lang.String id)

AlertMessageInfo(Timestamp time, int type, int prior, java.lang.String text, java.lang.String tag, java.lang.String svrName, java.lang.String svrAddr, java.lang.String form, java.lang.String id)

Method Summary

java.lang.String	getAlertText() Returns the text of the alert.
java.lang.String	getFormName() For AR System, returns the name of the form where the alert was generated from.
java.lang.String	getObjectId() Returns ID of the object of the alert.
int	getPriority() Returns the priority of the alert, for informational purposes only.
java.lang.String	getServerAddr() Returns the IP address of the server where the alert was generated from.
java.lang.String	getServerName() Returns the name of the server where the alert was generated from.
java.lang.String	getSourceTag() Returns a string identifying the source of the alert.
int	getSourceType() Returns value identifying the source of the alert.
Timestamp	getTimestamp() Returns the timestamp when the alert was created.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AlertMessageInfo

public AlertMessageInfo()

Default constructor

AlertMessageInfo

public AlertMessageInfo(Timestamp time,
                        int type,
                        int prior,
                        java.lang.String text,
                        java.lang.String tag,
                        java.lang.String svrName,
                        java.lang.String form,
                        java.lang.String id)

AlertMessageInfo

public AlertMessageInfo(Timestamp time,
                        int type,
                        int prior,
                        java.lang.String text,
                        java.lang.String tag,
                        java.lang.String svrName,
                        java.lang.String svrAddr,
                        java.lang.String form,
                        java.lang.String id)

Method Detail

getTimestamp

public Timestamp getTimestamp()

Returns the timestamp when the alert was created.

getSourceType

public int getSourceType()

Returns value identifying the source of the alert. If you do not want the sourceType returned, specify NULL for this parameter. Possible values are:

• 1: General purpose alert event
• 2: AR System alert event
• 3: First contact indicator
• 4: Accessibility check indicator
• 5: Flashboards alert event

getPriority

public int getPriority()

Returns the priority of the alert, for informational purposes only. The range of acceptable values is 0 to 10. If you do not want the priority returned, specify NULL for this parameter.

getAlertText

public java.lang.String getAlertText()

Returns the text of the alert. If you do not want the alertText returned, specify NULL for this parameter.

getSourceTag

public java.lang.String getSourceTag()

Returns a string identifying the source of the alert. If you do not want the sourceTag returned, specify NULL for this parameter.

getServerName

public java.lang.String getServerName()

Returns the name of the server where the alert was generated from. A value of @ indicates the current server. If you do not want the serverName returned, specify NULL for this parameter.

getServerAddr

public java.lang.String getServerAddr()

Returns the IP address of the server where the alert was generated from. If you do not want the serverAddr returned, specify NULL for this parameter.

getFormName

public java.lang.String getFormName()

For AR System, returns the name of the form where the alert was generated from. For Flashboards, returns the name of the flashboard that generated the alert. If you do not want the formName returned, specify NULL for this parameter.

getObjectId

public java.lang.String getObjectId()

Returns ID of the object of the alert.

• For AR System, this is the Entry ID.
• For Flashboards, this is the name of the Flashboard alert.