com.bmc.arsys.api
Class AlertMessageInfo

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

All Implemented Interfaces:

Serializable

public class AlertMessageInfo
extends Object
implements Serializable

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

See Also:

Serialized Form

Constructor Summary

AlertMessageInfo()
Default constructor

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

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

Method Summary

boolean	equals(Object obj) Use this method for checking equality between the current object and the provided one.
String	getAlertText() Returns the text of the alert.
String	getFormName() For AR System, returns the name of the form where the alert was generated from.
String	getObjectId() Returns ID of the object of the alert.
int	getPriority() Returns the priority of the alert, for informational purposes only.
String	getServerAddr() Returns the IP address of the server where the alert was generated from.
String	getServerName() Returns the name of the server where the alert was generated from.
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.
int	hashCode() Returns the hash code value for this instance of the current class.
String	toString() Returns a string description of the object.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

AlertMessageInfo

public AlertMessageInfo()

Default constructor

AlertMessageInfo

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

AlertMessageInfo

public AlertMessageInfo(Timestamp time,
                        int type,
                        int prior,
                        String text,
                        String tag,
                        String svrName,
                        String svrAddr,
                        String form,
                        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 String getAlertText()

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

getSourceTag

public 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 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 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 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 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.

toString

public String toString()

Returns a string description of the object.

Overrides:

toString in class Object

hashCode

public int hashCode()

Returns the hash code value for this instance of the current class. This method is supported as required by the general contract of Object.hashCode, for the benefit of hash tables such as those provided by java.util.Hashtable.

Overrides:

hashCode in class Object

Returns:

returns the hash code for this instance

equals

public boolean equals(Object obj)

Use this method for checking equality between the current object and the provided one. The result is true only if the argument is not null, is of the same type and represents the same content.

Overrides:

equals in class Object

Parameters:

obj - the object that we are comparing to

Returns:

returns a boolean that tells if the two objects equal