Skip navigation links


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

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

Direct Known Subclasses:
ConnectionStatus, DatabaseStatus, DownloadFileStatus, EditorOpenStatus, FileDownloadStatus, LogChartStatus, RestructureStatus, SessionStatus, UploadStatus

public class CommandStatus
extends XMLTransferMessage

Extends the XMLTransferMessage class to include information about the status of a command. This is a "special" message most often used to indicate that there is a problem between the command requested by the client and the ability of the server to execute that command.

Since:
6.5.4
Version:
7.1.0
Author:
Hank Cox

Field Summary
static int DUPLICATE
           
static int FAILURE
           
static int OUT_OF_MEMORY_ERROR
           
protected  java.lang.String server
          contains the name of the server that this command status object was created for.
static CommandStatus SIMPLE_DUPLICATE
           
static CommandStatus SIMPLE_FAILURE
          static singleton instantiation of a command status that is not successful; this object is provided so that command listeners don't have to continually be creating new command status objects.
static CommandStatus SIMPLE_SUCCESS
          static singleton instantiation of a command status that is successful; this object is provided so that command listeners don't have to continually be creating new command status objects.
static int SUCCESS
           
protected  java.lang.String user
          contains the string representing the user that this command status object was created for.

 

Fields inherited from class com.essbase.eas.framework.defs.transfer.XMLTransferMessage
decoded, decodedMessage, level, message, number, status

 

Constructor Summary
  CommandStatus()
          constructs a CommandStatus object with default values for each of the fields.
  CommandStatus(java.lang.String text)
          constructs a CommandStatus object with a specific message.
  CommandStatus(java.lang.String text, int status, int number)
          constructs a CommandStatus object with the requested values.
protected CommandStatus(java.lang.String text, int status, int level, int number, java.lang.String server, java.lang.String user)
          constructs a CommandStatus object with the requested values.

 

Method Summary
 java.lang.String getServer()
           
 java.lang.String getUser()
           
 boolean isDuplicate()
           
 boolean isFailure()
           
 boolean isSuccess()
           
 void setServer(java.lang.String name)
           
 void setUser(java.lang.String name)
           

 

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

SUCCESS

public static final int SUCCESS
See Also:
Constant Field Values

FAILURE

public static final int FAILURE
See Also:
Constant Field Values

DUPLICATE

public static final int DUPLICATE
See Also:
Constant Field Values

OUT_OF_MEMORY_ERROR

public static final int OUT_OF_MEMORY_ERROR
See Also:
Constant Field Values

SIMPLE_SUCCESS

public static final CommandStatus SIMPLE_SUCCESS
static singleton instantiation of a command status that is successful; this object is provided so that command listeners don't have to continually be creating new command status objects. These objects should never be modified by objects that use them.

SIMPLE_FAILURE

public static final CommandStatus SIMPLE_FAILURE
static singleton instantiation of a command status that is not successful; this object is provided so that command listeners don't have to continually be creating new command status objects. These objects should never be modified by objects that use them.

SIMPLE_DUPLICATE

public static final CommandStatus SIMPLE_DUPLICATE

server

protected java.lang.String server
contains the name of the server that this command status object was created for.

user

protected java.lang.String user
contains the string representing the user that this command status object was created for.

Constructor Detail

CommandStatus

public CommandStatus()
constructs a CommandStatus object with default values for each of the fields.

CommandStatus

public CommandStatus(java.lang.String text)
constructs a CommandStatus 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

CommandStatus

public CommandStatus(java.lang.String text,
                     int status,
                     int number)
constructs a CommandStatus 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.

CommandStatus

protected CommandStatus(java.lang.String text,
                        int status,
                        int level,
                        int number,
                        java.lang.String server,
                        java.lang.String user)
constructs a CommandStatus 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.
user - the user name for this message

Method Detail

getServer

public java.lang.String getServer()

setServer

public void setServer(java.lang.String name)

getUser

public java.lang.String getUser()

setUser

public void setUser(java.lang.String name)

isSuccess

public boolean isSuccess()

isFailure

public boolean isFailure()

isDuplicate

public boolean isDuplicate()

Skip navigation links


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