TML Messaging Suite  1.1.5
for Java
 All Classes Namespaces Functions Variables Groups Pages
Public Member Functions | Protected Member Functions | List of all members
com.tmlsidex.tml.TMLCmd Class Reference

The TMLCmd object provides an interface to a TML command and its data. More...

Inheritance diagram for com.tmlsidex.tml.TMLCmd:
com.tmlsidex.jni.TmlJniCmdProgressReplyIF com.tmlsidex.jni.TmlJniCmdStatusReplyIF com.tmlsidex.jni.TmlJniCmdReadyIF

Public Member Functions

void jniCmdProgressReplyCB (long cmdHandle, Object cbData, int progress)
 command progress handler implementation More...
 
void jniCmdStatusReplyCB (long cmdHandle, Object cbData, int type, String msg)
 command status reply handler implementation More...
 
void jniCmdReadyCB (long cmdHandle, Object cbData)
 command ready handler implementation More...
 
 TMLCmd (int iCmdID) throws TmlSidexException
 constructor of TMLCmd More...
 
 TMLCmd (int iCmdID, TMLCmdIF cbInstance, Object pCBData) throws TmlSidexException
 constructor of TMLCmd More...
 
 TMLCmd (long vHandle, boolean thisown) throws TmlSidexException
 constructor of TMLCmd More...
 
long getVHandle ()
 get low level command handle More...
 
void setCmdID (int cmdID) throws TmlSidexException
 set command id More...
 
int getCmdID () throws TmlSidexException
 get the command id More...
 
Date getCreationTime () throws TmlSidexException
 get command creation time More...
 
void setError (int error) throws TmlSidexException
 set error code More...
 
int getError () throws TmlSidexException
 get error code More...
 
void setErrorMessage (String msg) throws TmlSidexException
 set error message More...
 
String getErrorMessage () throws TmlSidexException
 get error message More...
 
int getMode () throws TmlSidexException
 get execution mode More...
 
void setProgress (int progress) throws TmlSidexException
 set progress More...
 
int getProgress () throws TmlSidexException
 get progress More...
 
String getReplyMessage () throws TmlSidexException
 get status reply message More...
 
int getReplyType () throws TmlSidexException
 get reply type More...
 
int getState () throws TmlSidexException
 get execution state More...
 
SDXDocument acquireData () throws TmlSidexException
 acquire command data (SDXDocument) More...
 
void releaseData () throws TmlSidexException
 release command data More...
 
void sendStatusReply (int rType, String rMsg) throws TmlSidexException
 send status reply More...
 
void sendProgressReply (int progress) throws TmlSidexException
 send progress reply More...
 
void registerCmdReady (TMLCmdReadyIF cbInstance, Object pCBData) throws TmlSidexException
 register command ready handler More...
 
void registerCmdProgressReply (TMLCmdProgressReplyIF cbInstance, Object pCBData) throws TmlSidexException
 register progress reply handler More...
 
void registerCmdStatusReply (TMLCmdStatusReplyIF cbInstance, Object pCBData) throws TmlSidexException
 register status reply handler More...
 
void registeredCmdReady (TMLCmdReadyIF[] cbInstance, Object[] pCBData) throws TmlSidexException
 get registered command ready handler and custom data More...
 
void registeredCmdProgressReply (TMLCmdProgressReplyIF[] cbInstance, Object[] pCBData) throws TmlSidexException
 get registered progress reply handler and custom data More...
 
void registeredCmdStatusReply (TMLCmdStatusReplyIF[] cbInstance, Object[] pCBData) throws TmlSidexException
 get registered status reply handler and custom data More...
 

Protected Member Functions

void finalize () throws Throwable
 destructor of TMLCmd More...
 

Additional Inherited Members

- Static Public Attributes inherited from com.tmlsidex.jni.TmlJniCmdProgressReplyIF
static final String CB_NAME = "jniCmdProgressReplyCB"
 command progress reply handler method name More...
 
- Static Public Attributes inherited from com.tmlsidex.jni.TmlJniCmdStatusReplyIF
static final String CB_NAME = "jniCmdStatusReplyCB"
 command status reply reply handler method name More...
 
- Static Public Attributes inherited from com.tmlsidex.jni.TmlJniCmdReadyIF
static final String CB_NAME = "jniCmdReadyCB"
 command ready handler method name More...
 

Detailed Description

The TMLCmd object provides an interface to a TML command and its data.