com.tivoli.twg.engine
Class ListMOStatusDefsCmd

java.lang.Object
  extended bycom.tivoli.twg.libs.Command
      extended bycom.tivoli.twg.engine.TWGServerCommand
          extended bycom.tivoli.twg.engine.ListMOStatusDefsCmd

public class ListMOStatusDefsCmd
extends TWGServerCommand

Command for listing status definitions. Supports pruning list of status definitions returned based on status group flags and status definition flags. For each, a bit mask is provided to determine which flags are significant, and a corresponding bit mask is used to specify the required values of those flags:

(flags & mask) == (value & mask) in order to match.


Field Summary
 
Fields inherited from class com.tivoli.twg.engine.TWGServerCommand
INVALID_PARAMETER_RC, TWGSERVERNAME, UNSUPPORTED_CMD
 
Fields inherited from class com.tivoli.twg.libs.Command
CMD_SENDER_FLAG, CMDRET_CREATE_CMDPKT_FAILED, CMDRET_ENCRYPT_FAIL, CMDRET_ENQUEUE_LOCAL_FAILED, CMDRET_INVALID_DEST_ADDRESS, CMDRET_NO_LOCAL_SVCNODE_IMPL, CMDRET_SECURE_FAIL, CMDRET_SEND_BUFFER_FAILED, CMDRET_SEND_FAILED, CMDRET_SEND_TIMEOUT, CMDRET_SERVICEFAILED, CMDRET_SESS_DISABLED_LCL, CMDRET_SESS_DISABLED_RMT, CMDRET_SESS_UNAVAIL_LCL, CMDRET_SESS_UNAVAIL_RMT, CMDRET_SESS_WAIT_DONE, CMDRET_SESS_WAIT_EXPIRED, CMDRET_SESS_WAITING, COMMAND_TYPE_INPUT, COMMAND_TYPE_OUTPUT, DEFAULT_CMD_TIMEOUT, ENQUEUE_FAILED_COPYDATA, ENQUEUE_FAILED_NO_DESTPATH, ENQUEUE_FAILED_NO_PROCESS_HANDLE, ENQUEUE_FAILED_NO_SVC_NODE_HANDLE, ENQUEUE_FAILED_SECURITY, ENQUEUE_GENERAL_FAILURE, JNI_BUFFER_NULL, JNI_ENTRY_POINT_NOT_LOADED, JNI_HANDLE_NULL, JNI_INITIALIZE_FAILED, RMI_LOOKUP_ERROR, SESSION_NONE, SESSION_PREFERRED, SESSION_REQUIRED
 
Constructor Summary
ListMOStatusDefsCmd()
          Constructor for listing all status definitions (no masking)
ListMOStatusDefsCmd(int grp_mask, int grp_value, int def_mask, int def_value)
          Constructor for listing status definitions where group flags match given value for given bitmask, and definition flags match given value with given bitmask.
 
Method Summary
 int getNumStatusDefs()
          Get number of definitions returned
 DataValue getStatusDefGroupLabel(int n)
          Return status group label for nth definition
 java.lang.String getStatusDefKey(int n)
          Return status key of nth definition
 DataValue getStatusDefLabel(int n)
          Return status definition label for nth definition
 boolean wasSuccessful()
          Test to see if update was successful
 
Methods inherited from class com.tivoli.twg.engine.TWGServerCommand
ServerCommandName
 
Methods inherited from class com.tivoli.twg.libs.Command
AddInputParm, AddInputParm, AddObjectAsInputParm, AddObjectAsOutputParm, AddOutputParm, AddOutputParm, addToDebugStrings, AllocateBuffer, AttachInputParm, AttachOutputParm, CmdId, CommandCode, commandCodeDebugString, CommandComplete, CompressObject, debugPrint, DecompressObject, DestinationAddress, DetachInputParm, DetachOutputParm, FreeBuffer, FreeInputsAfterSend, getCmdType, GetObjectFromInputParm, GetObjectFromOutputParm, getSenderServiceNode, hexDump, InputParm, InputParm, InputParmLength, IsFlatInputBuffer, IsFlatOutputBuffer, IsPostponedReply, MakeFlatInputBuffer, MakeFlatOutputBuffer, NumInputParms, NumOutputParms, OutputParm, OutputParm, OutputParmLength, Postpo neReply, ResetIndex, ResetInput, ResetOutput, ReturnAddress, ReturnCode, ReturnCodeToString, RootDestinationAddress, RootReturnAddress, SessionHold, SessionMode, SessionRelease, SessionWaitTime, setCmdType, setCmdTypeInput, setCmdTypeOutput, SetCommandCode, setCommandCodeDebugString, setCommandCompleteListener, SetDestinationAddress, SetNewID, SetReturnAddress, SetReturnCode, setSenderServiceNode, SetSessionHold, SetSessionMode, SetSessionRelease, SetSessionWaitTime, SetTimeOut, TimeOut, toString, UseFlatInputBuffer, UseFlatOutputBuffer
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

ListMOStatusDefsCmd

public ListMOStatusDefsCmd()
Constructor for listing all status definitions (no masking)


ListMOStatusDefsCmd

public ListMOStatusDefsCmd(int grp_mask,
                           int grp_value,
                           int def_mask,
                           int def_value)
Constructor for listing status definitions where group flags match given value for given bitmask, and definition flags match given value with given bitmask.

Parameters:
grp_mask - - bitmask for which group flags are to be tested
grp_value - - bitmask for values of group flags: in order to match, (grp_flags & grp_mask) must equal (grp_value & grp_mask)
def_mask - - bitmask for which definition flags are to be tested
def_value - - bitmask for values of definition flags: in order to match, (def_flags & def_mask) must equal (def_value & def_mask)
Method Detail

wasSuccessful

public boolean wasSuccessful()
Test to see if update was successful

Returns:
true if successful

getNumStatusDefs

public int getNumStatusDefs()
Get number of definitions returned

Returns:
number of records

getStatusDefKey

public java.lang.String getStatusDefKey(int n)
Return status key of nth definition

Parameters:
n - - index of definition to return
Returns:
status key, or null if not defined

getStatusDefGroupLabel

public DataValue getStatusDefGroupLabel(int n)
Return status group label for nth definition

Parameters:
n - - index of definition to return
Returns:
status group label, or null if not defined

getStatusDefLabel

public DataValue getStatusDefLabel(int n)
Return status definition label for nth definition

Parameters:
n - - index of definition to return
Returns:
status definition label, or null if not defined