com.ibm.sysmgt.sdk.remote
Class RemoteSdkGetApiDocumentation

java.lang.Object
  extended bycom.tivoli.twg.libs.Command
      extended bycom.ibm.sysmgt.sdk.remote.RemoteSdkGetApiDocumentation

public class RemoteSdkGetApiDocumentation
extends Command

Command to get the the documentation for a specific API.


Field Summary
static long REMOTE_SDK_GET_API_DOC_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
RemoteSdkGetApiDocumentation(java.lang.String apiName)
          Constructor
 
Method Summary
 java.util.List getApiDoc()
          getApiDoc
 java.lang.String getApiName()
          getApiName
 
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, PostponeReply, 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
 

Field Detail

REMOTE_SDK_GET_API_DOC_CMD

public static final long REMOTE_SDK_GET_API_DOC_CMD
See Also:
Constant Field Values
Constructor Detail

RemoteSdkGetApiDocumentation

public RemoteSdkGetApiDocumentation(java.lang.String apiName)
Constructor

Method Detail

getApiName

public java.lang.String getApiName()
getApiName


getApiDoc

public java.util.List getApiDoc()
getApiDoc

Returns:
A List of Strings with the API names