com.ibm.ram.client.status
Class RAMStatus

java.lang.Object
  extended by Status
      extended by com.ibm.ram.client.status.RAMStatus
All Implemented Interfaces:
RAMStatusCodes

public class RAMStatus
extends Status
implements RAMStatusCodes

Represents the outcome of an operation. Each CoreException carries a status object to indicate what went wrong. Status objects are also returned by methods that must provide the details of failures, such as validation methods.

Since:
7.1
Author:
kbauer

Field Summary
 
Fields inherited from interface com.ibm.ram.client.status.RAMStatusCodes
ADD_FAILED, ADD_SUCCESSFUL, ARCHIVE_FAILED, ARCHIVE_SUCCESSFUL, COMPLETE, CREATE_FAILED, CREATE_SUCCESSFUL, DELETE_FAILED, DELETE_SUCCESSFUL, IN_PROGRESS, REGISTER_FAILED, REGISTER_SUCCESSFUL, REMOVE_FAILED, REMOVE_SUCCESSFUL, RETIRE_FAILED, RETIRE_SUCCESSFUL, UNKNOWN_ERROR, UPDATE_FAILED, UPDATE_SUCCESSFUL, VALIDATION_FAILED, VALIDATION_SUCCESSFUL
 
Constructor Summary
RAMStatus()
          This constructor is for the root status message.
 
Method Summary
 void appendStatus(java.lang.Object targetObject, int severity, int code, java.lang.String message, java.lang.Throwable exception)
          This methods is used to append a runtime message to the over all RAM client operation status
 IStatus[] getChildren()
           
 java.lang.String getMessage()
           
 java.lang.Object getTargetObject()
          The object a child status message it targeted for
 boolean isMultiStatus()
           
 void setCode(int code)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

RAMStatus

public RAMStatus()
This constructor is for the root status message.

Since:
7.1
Method Detail

appendStatus

public void appendStatus(java.lang.Object targetObject,
                         int severity,
                         int code,
                         java.lang.String message,
                         java.lang.Throwable exception)
This methods is used to append a runtime message to the over all RAM client operation status

Parameters:
object -
severity -
code -
message -
exception -
Since:
7.1

setCode

public void setCode(int code)

getChildren

public IStatus[] getChildren()

getMessage

public java.lang.String getMessage()

isMultiStatus

public boolean isMultiStatus()

getTargetObject

public java.lang.Object getTargetObject()
The object a child status message it targeted for

Returns:
the sessionObject
Since:
7.1