org.safs

Class StatusCodes

java.lang.Object

org.safs.StatusCodes

public class StatusCodes
extends java.lang.Object

Purpose: holds the status codes (static final int fields)

Since:

JUN 04, 2003
JUN 04, 2003 (DBauman) Original Release
NOV 15, 2005 (Bob Lawler) Added BRANCH_TO_BLOCKID (RJL).
MAR 30, 2012 (Carl Nagle) Changed Interface to class and added static getStatusString method.

Author:

Doug Bauman

Field Summary

Fields

Modifier and Type	Field and Description
static int	BRANCH_TO_BLOCKID
static int	EXIT_TABLE_COMMAND
static int	GENERAL_SCRIPT_FAILURE
static int	IGNORE_RETURN_CODE
static int	INVALID_FILE_IO
static int	NO_RECORD_TYPE_FIELD
static int	NO_SCRIPT_FAILURE
static int	OK
static int	SCRIPT_NOT_EXECUTED
static int	SCRIPT_WARNING
static java.lang.String	STR_BRANCH_TO_BLOCKID
static java.lang.String	STR_EXIT_TABLE_COMMAND
static java.lang.String	STR_GENERAL_SCRIPT_FAILURE
static java.lang.String	STR_IGNORE_RETURN_CODE
static java.lang.String	STR_INVALID_FILE_IO
static java.lang.String	STR_NO_RECORD_TYPE_FIELD
static java.lang.String	STR_NO_SCRIPT_FAILURE
static java.lang.String	STR_OK
static java.lang.String	STR_SCRIPT_NOT_EXECUTED
static java.lang.String	STR_SCRIPT_WARNING
static java.lang.String	STR_UNRECOGNIZED_RECORD_TYPE
static java.lang.String	STR_WRONG_NUM_FIELDS
static int	UNRECOGNIZED_RECORD_TYPE
static int	WRONG_NUM_FIELDS

Constructor Summary

Constructors

Constructor and Description
StatusCodes()

Method Summary

Modifier and Type	Method and Description
static java.lang.String	getStatusString(int statuscode) Return the String human-readable representation of a valid statuscode constant.

Methods inherited from class java.lang.Object

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

Field Detail

NO_SCRIPT_FAILURE

public static final int NO_SCRIPT_FAILURE

See Also:

Constant Field Values

SCRIPT_WARNING

public static final int SCRIPT_WARNING

See Also:

Constant Field Values

GENERAL_SCRIPT_FAILURE

public static final int GENERAL_SCRIPT_FAILURE

See Also:

Constant Field Values

INVALID_FILE_IO

public static final int INVALID_FILE_IO

See Also:

Constant Field Values

SCRIPT_NOT_EXECUTED

public static final int SCRIPT_NOT_EXECUTED

See Also:

Constant Field Values

EXIT_TABLE_COMMAND

public static final int EXIT_TABLE_COMMAND

See Also:

Constant Field Values

IGNORE_RETURN_CODE

public static final int IGNORE_RETURN_CODE

See Also:

Constant Field Values

OK

public static final int OK

See Also:

Constant Field Values

NO_RECORD_TYPE_FIELD

public static final int NO_RECORD_TYPE_FIELD

See Also:

Constant Field Values

UNRECOGNIZED_RECORD_TYPE

public static final int UNRECOGNIZED_RECORD_TYPE

See Also:

Constant Field Values

WRONG_NUM_FIELDS

public static final int WRONG_NUM_FIELDS

See Also:

Constant Field Values

BRANCH_TO_BLOCKID

public static final int BRANCH_TO_BLOCKID

See Also:

Constant Field Values

STR_OK

public static final java.lang.String STR_OK

See Also:

Constant Field Values

STR_NO_SCRIPT_FAILURE

public static final java.lang.String STR_NO_SCRIPT_FAILURE

See Also:

Constant Field Values

STR_SCRIPT_WARNING

public static final java.lang.String STR_SCRIPT_WARNING

See Also:

Constant Field Values

STR_GENERAL_SCRIPT_FAILURE

public static final java.lang.String STR_GENERAL_SCRIPT_FAILURE

See Also:

Constant Field Values

STR_INVALID_FILE_IO

public static final java.lang.String STR_INVALID_FILE_IO

See Also:

Constant Field Values

STR_SCRIPT_NOT_EXECUTED

public static final java.lang.String STR_SCRIPT_NOT_EXECUTED

See Also:

Constant Field Values

STR_EXIT_TABLE_COMMAND

public static final java.lang.String STR_EXIT_TABLE_COMMAND

See Also:

Constant Field Values

STR_IGNORE_RETURN_CODE

public static final java.lang.String STR_IGNORE_RETURN_CODE

See Also:

Constant Field Values

STR_NO_RECORD_TYPE_FIELD

public static final java.lang.String STR_NO_RECORD_TYPE_FIELD

See Also:

Constant Field Values

STR_UNRECOGNIZED_RECORD_TYPE

public static final java.lang.String STR_UNRECOGNIZED_RECORD_TYPE

See Also:

Constant Field Values

STR_WRONG_NUM_FIELDS

public static final java.lang.String STR_WRONG_NUM_FIELDS

See Also:

Constant Field Values

STR_BRANCH_TO_BLOCKID

public static final java.lang.String STR_BRANCH_TO_BLOCKID

See Also:

Constant Field Values

Constructor Detail

StatusCodes

public StatusCodes()

Method Detail

getStatusString

public static java.lang.String getStatusString(int statuscode)

Return the String human-readable representation of a valid statuscode constant. Ex: if the provided status code is 4, the routine returns "SCRIPT_NOT_EXECUTED".

Parameters:

statuscode - to convert to readable string.

Returns:

readable status string, or null if the statuscode was not known.