au.gov.aao.drama
Class DramaErs

java.lang.Object
  au.gov.aao.drama.DramaErs

public class DramaErs
extends Object

The DramaErs class is used to access the DRAMA ERS library.

NOTE 1: If you use these methods from code which is not part of a DRAMA action handler or UFACE handler, then you should enclose a sequence of calls by DramaSem.Take()/DramaSem.Release() and finish with a Flush()/Output()/Annul() call. Otherwise, there may be interference from the DRAMA thread.

NOTE 2: You will not want to use this methods from within an exception handler, as these functions may throw exceptions themselves. In this case, consider using the Report and Flush functions from DramaException, which don't throw exceptions but otherwise do the same job.

Version:

@(#) $Id: ACMM:DramaJava/DramaErs.java,v 3.52 17-Sep-2009 14:08:20+10 tjf $

Author:

Tony Farrell

See Also:

DramaStatus, DramaSem, DramaException

Field Summary

static String

RCSID The RCS (ACMM) ID.

Method Summary

static void	Annul() Annul messages at the current DRAMA Error reporting context.
static void	Flush() Flush messages at the current DRAMA Error reporting context.
static void	Output(String message) Report a message use the DRAMA Ers facility and flush all messages reported at the current context.
static void	Output(String message, DramaStatus status) Report a message use the DRAMA Ers facility and flush all messages reported at the current context.
static void	Pop() Pop the DRAMA Error reporting context.
static void	Push() Push the DRAMA Error reporting context.
static void	Report(String message) Report a message use the DRAMA Ers facility.
static void	Report(String message, DramaStatus status) Report a message use the DRAMA Ers facility

Methods inherited from class java.lang.Object

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

Field Detail

RCSID

public static final String RCSID

The RCS (ACMM) ID. This field returns the source code archive ID of this class's source file.

The returned string corresponds to the version string seen above (in the class description comments), but will contain the version details of the compiled class file's actual source file.

(ACMM is the source code archive system used by the AAO. If the string returned by RCSID does not contain the string ACMM, then it is likely the source code has been archived again outside the AAO).

See Also:

Constant Field Values

Method Detail

Report

public static void Report(String message)
                   throws DramaException

Report a message use the DRAMA Ers facility.

The OK status code is assoicated with the report - which is not usual DRAMA style, but is not an error. Normally a particular bad status code will be associated with an report.

Parameters:

message - The message to report.

Throws:

DramaException - thrown on errors in the DRAMA code.

Report

public static void Report(String message,
                          DramaStatus status)
                   throws DramaException

Report a message use the DRAMA Ers facility

Parameters:

message - The message to report.

status - The DRAMA status code to be assoicated with this report

Throws:

DramaException - thrown on errors in the DRAMA code.

Output

public static void Output(String message)
                   throws DramaException

Report a message use the DRAMA Ers facility and flush all messages reported at the current context.

The OK status code is assoicated with the report - which is not usual DRAMA style, but is not an error. Normally a particular bad status code will be associated with an report.

Parameters:

message - The message to report.

Throws:

DramaException - thrown on errors in the DRAMA code.

Output

public static void Output(String message,
                          DramaStatus status)
                   throws DramaException

Report a message use the DRAMA Ers facility and flush all messages reported at the current context.

Parameters:

message - The message to report.

status - The DRAMA status code to be assoicated with this report

Throws:

DramaException - thrown on errors in the DRAMA code.

Push

public static void Push()

Push the DRAMA Error reporting context.

Pop

public static void Pop()

Pop the DRAMA Error reporting context.

Annul

public static void Annul()
                  throws DramaException

Annul messages at the current DRAMA Error reporting context.

Throws:

DramaException - thrown on errors in the DRAMA code.

Flush

public static void Flush()
                  throws DramaException

Flush messages at the current DRAMA Error reporting context.

Throws:

DramaException - thrown on errors in the DRAMA code.