com.uc4.communication.requests

Class ActiveNotifications.Entry

java.lang.Object

com.uc4.communication.requests.ActiveNotifications.Entry

Enclosing class:

ActiveNotifications

public static class ActiveNotifications.Entry
extends Object

This class represents a row in the table of active notifications.

Method Summary

Modifier and Type	Method and Description
DateTime	getEscalation() Returns the date and time on which the Notification escalates.
String	getMessage() Returns the message text of this notification.
UC4ObjectName	getName() Returns the name of the Notification object.
String	getPriority() Returns the Priority of the Notification (high, normal, low).
int	getRunID() Returns the RunID of this notification.
DateTime	getStartTime() Returns the start time of this notification.
int	getStatusCode() Returns the status of the task as integer.
String	getStatusText() Returns a description of the status.
String	getTypeText() Translated type text, for example Email, Message, Request or Alert.
boolean	hasComment() Returns true if this notification has comments.

Methods inherited from class java.lang.Object

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

Method Detail

getMessage

public String getMessage()

Returns the message text of this notification.

Returns:

Message text

getName

public UC4ObjectName getName()

Returns the name of the Notification object.

Returns:

Name

getEscalation

public DateTime getEscalation()

Returns the date and time on which the Notification escalates. The specified Notification starts if there is no user acknowledgement. A particular point in time is only displayed if a definition was made in the setting "Escalation" of the "Operator" tab.

Returns:

DateTime instance, which can be empty but never null

getStatusCode

public final int getStatusCode()

Returns the status of the task as integer.

Returns:

Status code or -1 in case of an error. Possible return values are described in the status: AbstractTask.getStatusCode()

getStatusText

public final String getStatusText()

Returns a description of the status. This return value depends on the logon language.

Returns:

description for task status. Possible return values are described in the status: AbstractTask.getStatusCode()

getStartTime

public DateTime getStartTime()

Returns the start time of this notification.

Returns:

Start time

getTypeText

public String getTypeText()

Translated type text, for example Email, Message, Request or Alert.

Returns:

Type of the notification

getPriority

public String getPriority()

Returns the Priority of the Notification (high, normal, low).

Returns:

translated priority, for example "High" (English) or "Hoch" (German)

hasComment

public boolean hasComment()

Returns true if this notification has comments. The request GetComments can be used to get the detail of the comment.

Returns:

true if comments are stored

getRunID

public int getRunID()

Returns the RunID of this notification.

Returns:

RunID