Skip navigation links


com.essbase.eas.essbase.defs.transfer
Class EssbaseMessage

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


public class EssbaseMessage
extends XMLTransferMessage

Extends the XMLTransferMessage class to include information about the messages returned from the Essbase server or the mid tier.

Since:
6.5.4
Version:
6.5.4
Author:
Namita Varma

Field Summary
static int CRITICAL_LEVEL
           
static int ERROR_LEVEL
           
static int EXCEPTION_LEVEL
           
static int FAILURE
           
static int INFO_LEVEL
           
static int SUCCESS
           
static int USER_INTERRUPT
           
static int WARNING_LEVEL
           

 

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

 

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

 

Method Summary
 EssbaseMessage[] getEmbeddedMessages()
           
 java.lang.String getServer()
           
 java.lang.String getUser()
           
 void setEmbeddedMessages(EssbaseMessage[] value)
           
 void setServer(java.lang.String name)
           
 void setUser(java.lang.String name)
           
 java.lang.String toString()
           

 

Methods inherited from class com.essbase.eas.framework.defs.transfer.XMLTransferMessage
getLevel, getMessage, getNumber, getOriginalMessage, getStatus, setLevel, setMessage, setNumber, setStatus

 

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

USER_INTERRUPT

public static final int USER_INTERRUPT
See Also:
Constant Field Values

INFO_LEVEL

public static final int INFO_LEVEL
See Also:
Constant Field Values

WARNING_LEVEL

public static final int WARNING_LEVEL
See Also:
Constant Field Values

ERROR_LEVEL

public static final int ERROR_LEVEL
See Also:
Constant Field Values

CRITICAL_LEVEL

public static final int CRITICAL_LEVEL
See Also:
Constant Field Values

EXCEPTION_LEVEL

public static final int EXCEPTION_LEVEL
See Also:
Constant Field Values

Constructor Detail

EssbaseMessage

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

EssbaseMessage

public EssbaseMessage(XMLTransferMessage msg)
constructs a EssbaseMessage object with default values for each of the fields.

EssbaseMessage

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

EssbaseMessage

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

EssbaseMessage

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

EssbaseMessage

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

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)

getEmbeddedMessages

public EssbaseMessage[] getEmbeddedMessages()

setEmbeddedMessages

public void setEmbeddedMessages(EssbaseMessage[] value)

toString

public java.lang.String toString()
Overrides:
toString in class XMLTransferMessage

Skip navigation links


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