Skip navigation links


com.essbase.eas.framework.defs.command
Class CommandFailureException

java.lang.Object
  extended by java.lang.Throwable
      extended by java.lang.Exception
          extended by com.essbase.eas.framework.defs.command.CommandFailureException

All Implemented Interfaces:
java.io.Serializable

public class CommandFailureException
extends java.lang.Exception

Signals that a command sent to the EAS server did not complete as expected. This exception would be raised in the client application when processing the results of a command.

Since:
6.5.4
Version:
7.1.0
Author:
Namita Varma
See Also:
Serialized Form

Constructor Summary
CommandFailureException()
          Constructs a CommandFailureException with no specified detail message.
CommandFailureException(CommandStatus cmdStatus)
          Constructs a CommandFailureException with the specified detail message.
CommandFailureException(CommandStatus cmdStatus, java.lang.Object[] msgs, java.lang.String source)
          Constructs a CommandFailureException with the specified command status, message list and a detailed message
CommandFailureException(CommandStatus cmdStatus, java.lang.Object[] msgs, java.lang.String source, java.lang.String sourceObject)
          Constructs a CommandFailureException with the specified CommandStatus, message list, source command string and the source object.
CommandFailureException(CommandStatus cmdStatus, java.lang.String source)
          Constructs a CommandFailureException with the specified detail message.

 

Method Summary
 CommandStatus getCommandStatus()
          Gets the CommandStatus object associated with this exception.
 java.lang.String getCommandString()
          Gets the text representation of the command that failed.
 java.lang.Object[] getMessages()
          Gets the messages returned from the EAS server as part of the command failure.
 java.lang.String getSourceObject()
          Gets the text representation of the source object that generated the exception.
 void setCommandStatus(CommandStatus cmdStatus)
          Sets the CommandStatus object to be used with this exception.
 void setCommandString(java.lang.String commandStr)
          Sets the text representation of the command that failed.
 void setMessages(java.lang.Object[] msgs)
          Sets the messages for the command failure.
 void setSourceObject(java.lang.String source)
          Sets the source object that generated this Exception.

 

Methods inherited from class java.lang.Throwable
fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

 

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

 

Constructor Detail

CommandFailureException

public CommandFailureException()
Constructs a CommandFailureException with no specified detail message.

CommandFailureException

public CommandFailureException(CommandStatus cmdStatus)
Constructs a CommandFailureException with the specified detail message.
Parameters:
cmdStatus - The CommandStatus object that was returned from the EAS server.

CommandFailureException

public CommandFailureException(CommandStatus cmdStatus,
                               java.lang.String source)
Constructs a CommandFailureException with the specified detail message.
Parameters:
cmdStatus - the CommandStatus object that was returned from the EAS server.
source - is the command string that was sent to the EAS server

CommandFailureException

public CommandFailureException(CommandStatus cmdStatus,
                               java.lang.Object[] msgs,
                               java.lang.String source)
Constructs a CommandFailureException with the specified command status, message list and a detailed message
Parameters:
cmdStatus - the CommandStatus object that was returned from the EAS server.
msgs - array of objects containing messages returned from the EAS server
source - is the command string that was sent to the EAS server

CommandFailureException

public CommandFailureException(CommandStatus cmdStatus,
                               java.lang.Object[] msgs,
                               java.lang.String source,
                               java.lang.String sourceObject)
Constructs a CommandFailureException with the specified CommandStatus, message list, source command string and the source object.
Parameters:
cmdStatus - the CommandStatus object that was returned from the EAS server.
msgs - array of objects containing messages returned from the EAS server
source - is the command string that was sent to the EAS server
sourceObject - is the object associated with the sent command

Method Detail

getCommandStatus

public CommandStatus getCommandStatus()
Gets the CommandStatus object associated with this exception. The CommandStatus object contains detailed information about why the command failed.
Returns:
the CommandStatus object for the command

setCommandStatus

public void setCommandStatus(CommandStatus cmdStatus)
Sets the CommandStatus object to be used with this exception. This method should rarely be called, as the command status object should be set by calling the appropriate constructor.
Parameters:
cmdStatus - the status to be associated with this exception.

getCommandString

public java.lang.String getCommandString()
Gets the text representation of the command that failed.
Returns:
command name

setCommandString

public void setCommandString(java.lang.String commandStr)
Sets the text representation of the command that failed. This method should rarely be called, as the command status object should be set by calling the appropriate constructor.
Parameters:
commandStr - the command

getSourceObject

public java.lang.String getSourceObject()
Gets the text representation of the source object that generated the exception.
Returns:
the source object for the exception.

setSourceObject

public void setSourceObject(java.lang.String source)
Sets the source object that generated this Exception. This method should rarely be called, as the command status object should be set by calling the appropriate constructor.
Parameters:
source - the string representing the source object.

getMessages

public java.lang.Object[] getMessages()
Gets the messages returned from the EAS server as part of the command failure. The can be an array of length zero.
Returns:
the messages for the command failure

setMessages

public void setMessages(java.lang.Object[] msgs)
Sets the messages for the command failure. This method should rarely be called, as the command status object should be set by calling the appropriate constructor.
Parameters:
msgs - an array of messages returned from the EAS server.

Skip navigation links


Copyright © 2001, 2012, Oracle. All rights reserved.