de.desy.tine.definitions.TErrorList Class Reference

TINE Static error strings. More...

Static Public Member Functions
static int	getErrorCode (int code)
	Removes informational bits from the given error code. More...
static String	getErrorString (int code)
	Interprets system error code as string. More...
static String	getLongErrorString (int code)
	Interprets system error code as a lengthier explanatory string. More...
static String	toString (int code)
	Interprets system error code as string. More...
static boolean	hasData (int code)
	Determines whether the given status (return) code also implies that data have been returned in the call. More...
static boolean	isRedirected (int code)
	Determines whether the given return code also implies that data have been returned from a different source than that given in the call. More...
static int	registerErrorCode (int code, String msgShort, String msgLong)
	Registers the error code given and associates with the given message strings. More...

Detailed Description

TINE Static error strings.

Member Function Documentation

getErrorCode()

static int de.desy.tine.definitions.TErrorList.getErrorCode ( int  code )

static

Removes informational bits from the given error code.

Parameters

code	is the tine error code for which the undecorated error code is desired

getErrorString()

static String de.desy.tine.definitions.TErrorList.getErrorString ( int  code )

static

Interprets system error code as string.

Parameters

code	is the tine error code for which the error string is desired

Referenced by de.desy.tine.client.TLink.execute(), de.desy.tine.client.TLink.getError(), de.desy.tine.queryUtils.TQuery.getPropertiesWithPattern(), de.desy.tine.queryUtils.TQuery.pingServer(), de.desy.tine.server.equipment.TEquipmentModule.registerProperty(), and de.desy.tine.definitions.TErrorList.toString().

getLongErrorString()

static String de.desy.tine.definitions.TErrorList.getLongErrorString ( int  code )

static

Interprets system error code as a lengthier explanatory string.

Parameters

code	is the tine error code for which the long error string is desired

hasData()

static boolean de.desy.tine.definitions.TErrorList.hasData ( int  code )

static

Determines whether the given status (return) code also implies that data have been returned in the call.

Parameters

code	is the status (return) code to be examined

Returns

true or false

Referenced by de.desy.tine.client.TLink.execute(), de.desy.tine.queryUtils.TQuery.getDeviceServerReport(), and de.desy.tine.accesslayer.ChannelFactory.getRawValue().

isRedirected()

static boolean de.desy.tine.definitions.TErrorList.isRedirected ( int  code )

static

Determines whether the given return code also implies that data have been returned from a different source than that given in the call.

Parameters

code	is the return (error) code to be examined

Returns

true or false

registerErrorCode()

static int de.desy.tine.definitions.TErrorList.registerErrorCode ( int  code, String  msgShort, String  msgLong  )

static

Registers the error code given and associates with the given message strings.

Parameters

code	is the user-specified error code (512 or above) which can be returned from an equipment module or property handler.
msgShort	is a short message string (32 characters or less) supplying a brief description of the error.
msgLong	is a long message string (128 characters or less) supplying a more descriptive explanation of the error.

Returns

0 upon success or a TINE error code (e.g. invalid_return_code) upon error.

toString()

static String de.desy.tine.definitions.TErrorList.toString ( int  code )

static

Interprets system error code as string.

Parameters

code	is the tine error code for which the error string is desired

References de.desy.tine.definitions.TErrorList.getErrorString().

Referenced by de.desy.tine.client.TLink.execute(), de.desy.tine.queryUtils.TQuery.getDeviceServerReport(), de.desy.tine.queryUtils.TQuery.getDeviceServersEx(), de.desy.tine.queryUtils.TQuery.getPropertyInformation(), de.desy.tine.accesslayer.ChannelFactory.getRawValue(), de.desy.tine.queryUtils.TQuery.getServersEx(), and de.desy.tine.queryUtils.TQuery.getStockPropertyInformation().

---

The documentation for this class was generated from the following file:

• TErrorList.java