Skip navigation links

com.essbase.eas.essbase.defs.command
Class ConnectionStatus

java.lang.Object
com.essbase.eas.framework.defs.transfer.XMLTransferMessage
com.essbase.eas.framework.defs.command.CommandStatus
com.essbase.eas.essbase.defs.command.ConnectionStatus

public class ConnectionStatus

extends CommandStatus

The is the status object created when an Essbase server connection is not valid for some reason.

Since:

7.0.0

Version:

7.0.0

Author:

Hyperion Solutions

Field Summary

static int	SERVER_CONNECT_ERROR contains the value used when a connection just couldn't be made to the Essbase server.
static int	TOKEN_TIMEOUT_ERROR

Fields inherited from class com.essbase.eas.framework.defs.command.CommandStatus

DUPLICATE, FAILURE, OUT_OF_MEMORY_ERROR, server, SIMPLE_DUPLICATE, SIMPLE_FAILURE, SIMPLE_SUCCESS, SUCCESS, user

Fields inherited from class com.essbase.eas.framework.defs.transfer.XMLTransferMessage

decoded, decodedMessage, level, message, number, status

Constructor Summary

	ConnectionStatus()
	ConnectionStatus(java.lang.String text) constructs a ConnectionStatus object with a specific message.
	ConnectionStatus(java.lang.String text, int status, int number) constructs a ConnectionStatus object with the requested values.
	ConnectionStatus(java.lang.String text, int status, int number, int reason) constructs a ConnectionStatus object with the requested value and a reason code
protected	ConnectionStatus(java.lang.String text, int status, int level, int number, java.lang.String server, java.lang.String user) constructs a ConnectionStatus object with the requested values.

Method Summary

int	getReason() Extended reason code
void	setReason(int reason) Set the extended reason code

Methods inherited from class com.essbase.eas.framework.defs.command.CommandStatus

getServer, getUser, isDuplicate, isFailure, isSuccess, setServer, setUser

Methods inherited from class com.essbase.eas.framework.defs.transfer.XMLTransferMessage

getLevel, getMessage, getNumber, getOriginalMessage, getStatus, setLevel, setMessage, setNumber, setStatus, toString

Methods inherited from class java.lang.Object

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

Field Detail

SERVER_CONNECT_ERROR

public static final int SERVER_CONNECT_ERROR

contains the value used when a connection just couldn't be made to the Essbase server.

See Also:

Constant Field Values

TOKEN_TIMEOUT_ERROR

public static final int TOKEN_TIMEOUT_ERROR

See Also:

Constant Field Values

Constructor Detail

ConnectionStatus

public ConnectionStatus()

ConnectionStatus

public ConnectionStatus(java.lang.String text)

constructs a ConnectionStatus object with a specific message. Sets the status to success and the level and message number to 0.

Parameters:

text - the text of the message

ConnectionStatus

public ConnectionStatus(java.lang.String text,
                        int status,
                        int number)

constructs a ConnectionStatus object with the requested values.

Parameters:

text - the text of the message

status - the success/failure of this message.

number - the message number for this message.

ConnectionStatus

public ConnectionStatus(java.lang.String text,
                        int status,
                        int number,
                        int reason)

constructs a ConnectionStatus object with the requested value and a reason code

Parameters:

text -

status -

number -

reason -

ConnectionStatus

protected ConnectionStatus(java.lang.String text,
                           int status,
                           int level,
                           int number,
                           java.lang.String server,
                           java.lang.String user)

constructs a ConnectionStatus object with the requested values.

Parameters:

text - the text of the message

status - the success/failure of this message.

level - the level for this message.

number - the message number for this message.

server - the server name for this message.

the - user name for this message

Method Detail

getReason

public int getReason()

Extended reason code

Returns:

- the reason

setReason

public void setReason(int reason)

Set the extended reason code

Parameters:

reason -

Skip navigation links