au.gov.aao.drama
Class DramaTask.ErsMessage

java.lang.Object
  au.gov.aao.drama.DramaTask.ErsMessage

Enclosing class:

DramaTask

public static class DramaTask.ErsMessage
extends Object

A Class used to represent a DRAMA ERS message report.

A DRAMA ERS message report contains not just the text of the message but indicates of formating to be applied to the message and the DRAMA status associated with the original report.

Field Summary

static int	ALARM Indicates the message is very important and should probably be acknowledged by the user.
static int	BELL Indicates the terminal bell should be rung when the message is displayed.
static int	HIGHLIGHT Indicates the message should be Highlite when displayed.

Constructor Summary

DramaTask.ErsMessage(String t, int f, int s)
Construct an ERS message object.

Method Summary

boolean	Alarm() Indicate if the ALARM flag of the message has been set.
boolean	Highlight() Indicate if the HIGHLIGH flag of the message has been set.
boolean	RingBell() Indicate if the BELL flag of the message has been set.
DramaStatus	Status() Return the DRAMA status of the ERS message.
String	toString() Return the text of the ERS message.

Methods inherited from class java.lang.Object

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

Field Detail

HIGHLIGHT

public static final int HIGHLIGHT

Indicates the message should be Highlite when displayed.

See Also:

Constant Field Values

BELL

public static final int BELL

Indicates the terminal bell should be rung when the message is displayed.

See Also:

Constant Field Values

ALARM

public static final int ALARM

Indicates the message is very important and should probably be acknowledged by the user.

See Also:

Constant Field Values

Constructor Detail

DramaTask.ErsMessage

public DramaTask.ErsMessage(String t,
                            int f,
                            int s)

Construct an ERS message object.

Whilst you can construct one of these objects yourself, they are nomally constructed by DRAMA itself.

Parameters:

t - The text component of the message

f - The flags assocaited with the message, a logical or of HIGLIGHT, BELL or ALARM, as required.

s - The integer version of the DRAMA status assocaited with this error report.

Method Detail

toString

public String toString()

Return the text of the ERS message.

Overrides:

toString in class Object

Status

public DramaStatus Status()

Return the DRAMA status of the ERS message.

RingBell

public boolean RingBell()

Indicate if the BELL flag of the message has been set.

Alarm

public boolean Alarm()

Indicate if the ALARM flag of the message has been set.

Highlight

public boolean Highlight()

Indicate if the HIGHLIGH flag of the message has been set.