Skip navigation links


com.essbase.api.base
Interface IEssException

All Superinterfaces:
IEssBaseObject

public interface IEssException
extends IEssBaseObject

The IEssException interface.

Version:
1.0, 04/04/2001
Author:
Srini Ranga

Field Summary
static int ERROR_CLUSTER_NODE_DOWN
          Error ID: Error when the current cluster node is disabled or down.
static int ERROR_CONCURRENT_SESSION_ACCESS
          Error ID: Error when a request comes for a session that is already executing a request.
static int ERROR_INVALID_SESSION_ID
          Error: Invalid session id.
static int ERROR_INVALID_USER_OR_PASSWORD
          Error: Invalid user name or password.
static int ERROR_NATIVE_FROM_OLAP_SERVER
          Error: OLAP server native error.
static int ERROR_NEW_PROP_VALUE_SAME_AS_OLD
          Error: New value for a property cannot be same as the old.
static int ERROR_OBJECT_ALREADY_EXISTS
          Error: Object already exists.
static int ERROR_OBJECT_IS_CLOSED
          Error: Object is closed.
static int ERROR_OBJECT_NOT_FOUND
          Error: Object is not found.
static int ERROR_UNCATEGORIZED
          The error is not categorized yet.

 

Method Summary
 int getCode()
          Gets the error code.
 java.lang.String getMessage()
          Gets the error message.
 int getNativeCode()
          Gets the native error code.
 java.lang.String getNativeMessage()
          Gets the native error message.
 void setCode(int code)
          Sets the error code.
 void setMessage(java.lang.String message)
          Sets the error message.
 void setNativeCode(int code)
          Sets the native error code.
 void setNativeMessage(java.lang.String message)
          Sets the native error message.

 

Field Detail

ERROR_OBJECT_NOT_FOUND

static final int ERROR_OBJECT_NOT_FOUND
Error: Object is not found.
See Also:
Constant Field Values

ERROR_OBJECT_ALREADY_EXISTS

static final int ERROR_OBJECT_ALREADY_EXISTS
Error: Object already exists.
See Also:
Constant Field Values

ERROR_OBJECT_IS_CLOSED

static final int ERROR_OBJECT_IS_CLOSED
Error: Object is closed.
See Also:
Constant Field Values

ERROR_NATIVE_FROM_OLAP_SERVER

static final int ERROR_NATIVE_FROM_OLAP_SERVER
Error: OLAP server native error. Use getNativeCode()/getNativeMessage() to get the native error code/message. For a list of error codes and messages from OLAP server, refer the Essbase OLAP server documentation.
See Also:
Constant Field Values

ERROR_UNCATEGORIZED

static final int ERROR_UNCATEGORIZED
The error is not categorized yet. Use getMessage() only for details.
See Also:
Constant Field Values

ERROR_INVALID_SESSION_ID

static final int ERROR_INVALID_SESSION_ID
Error: Invalid session id. This error will occur if the user got signed off from the enterprise server by the administrator, or by time out, or if the enterprise server is restarted while the user session is in progress.
See Also:
Constant Field Values

ERROR_NEW_PROP_VALUE_SAME_AS_OLD

static final int ERROR_NEW_PROP_VALUE_SAME_AS_OLD
Error: New value for a property cannot be same as the old. For eg, new value for property password cannot be same as the old password.
See Also:
Constant Field Values

ERROR_INVALID_USER_OR_PASSWORD

static final int ERROR_INVALID_USER_OR_PASSWORD
Error: Invalid user name or password.
See Also:
Constant Field Values

ERROR_CLUSTER_NODE_DOWN

static final int ERROR_CLUSTER_NODE_DOWN
Error ID: Error when the current cluster node is disabled or down.
See Also:
Constant Field Values

ERROR_CONCURRENT_SESSION_ACCESS

static final int ERROR_CONCURRENT_SESSION_ACCESS
Error ID: Error when a request comes for a session that is already executing a request.
See Also:
Constant Field Values

Method Detail

getCode

int getCode()
Gets the error code.
Returns:
The error code.

setCode

void setCode(int code)
Sets the error code.
Parameters:
code - The error code.

getMessage

java.lang.String getMessage()
Gets the error message.
Returns:
The error message.

setMessage

void setMessage(java.lang.String message)
Sets the error message.
Parameters:
message - The error message.

getNativeCode

int getNativeCode()
Gets the native error code.
Returns:
The native error code.

setNativeCode

void setNativeCode(int code)
Sets the native error code.
Parameters:
code - The native error code.

getNativeMessage

java.lang.String getNativeMessage()
Gets the native error message.
Returns:
The native error message.

setNativeMessage

void setNativeMessage(java.lang.String message)
Sets the native error message.
Parameters:
message - The native error message.

Skip navigation links