net.bioclipse.xws.client.adhoc
Interface IProcess


public interface IProcess


Method Summary
 IFunction getFunction()
          Returns the function associated with the process.
 void getResult()
          Requests the result of the remote process and also terminates (deletes) it.
 void getResult(boolean deleteProcess)
          Requests the result of the remote process.
 IService getService()
          Returns the XMPP Service associated with the process.
 java.lang.String getSessionID()
          Returns the session ID associated with the process.
 ProcessStatusCode getStatusCode()
          Returns the process status code.
 boolean isTerminated()
          Returns true if the remote process was terminated (deleted).
 void terminate()
          Terminates (deletes) a remote process.
 java.lang.String toString()
          Returns a String with information about the associated function and process status.
 

Method Detail

toString

java.lang.String toString()
Returns a String with information about the associated function and process status.

Overrides:
toString in class java.lang.Object
Returns:
The String representation of the remote process.

getFunction

IFunction getFunction()
Returns the function associated with the process.

Returns:
The function associated with the process.

getService

IService getService()
Returns the XMPP Service associated with the process.

Returns:
The XMPP Service associated with the process.

getSessionID

java.lang.String getSessionID()
Returns the session ID associated with the process. The persistence of the remote process does not necessarily depend on the persistence of the client or client connection. The client may save the session ID to pick the process at a later date.

Returns:
The session ID.

getStatusCode

ProcessStatusCode getStatusCode()
Returns the process status code.

Returns:
The process status code.

isTerminated

boolean isTerminated()
Returns true if the remote process was terminated (deleted). Returns false otherwise.

Returns:
true if the remote process was terminated (deleted). false otherwise.

terminate

void terminate()
               throws XmppException
Terminates (deletes) a remote process.

Throws:
XmppException

getResult

void getResult()
               throws XmppException
Requests the result of the remote process and also terminates (deletes) it. Same as get getResult(true). The result of the remote process corresponds to the output of the XMPP Service function.

Throws:
XmppException

getResult

void getResult(boolean deleteProcess)
               throws XmppException
Requests the result of the remote process. The requester can decide to also terminate (delete) the remote process or not. If the requester decides to not terminate (delete) the remote process it is responsible (!) for terminating (deleting) it later. The result of the remote process corresponds to the output of the XMPP Service function.

Parameters:
deleteProcess - If true the remote process will also be terminated (deleted). If false the remote process continues to exist. The requester is responsible for terminating (deleting) it later, for example after the result was successfully received.
Throws:
XmppException