net.bioclipse.xws.component.xmpp.process
Interface IProcessStatus

public interface IProcessStatus

Method Summary

java.lang.String	getClientJid() Returns the JID of the requester.
boolean	isCanceled() Returns true if the process was canceled (terminated/deleted) by the requester.
void	setError(java.lang.String statusMessage) Sets the status of the process to "error".
void	setResult(org.w3c.dom.Element output, java.lang.String statusMessage) Sets the result (output) of the process, the status of the process is set to "finished" if this is a time consuming (delayed/asynchronous) function, otherwise the status of the process is set to "terminated" (deleted).
void	updateStatusMessage(java.lang.String statusMessage) Updates the status message of the process.

Method Detail

updateStatusMessage

void updateStatusMessage(java.lang.String statusMessage)

Updates the status message of the process.

Parameters:

statusMessage - The status message of the process.

setResult

void setResult(org.w3c.dom.Element output,
               java.lang.String statusMessage)

Sets the result (output) of the process, the status of the process is set to "finished" if this is a time consuming (delayed/asynchronous) function, otherwise the status of the process is set to "terminated" (deleted).

Parameters:

output - The result (output).

statusMessage - The status message of the process.

setError

void setError(java.lang.String statusMessage)

Sets the status of the process to "error".

Parameters:

statusMessage - The status message of the process.

isCanceled

boolean isCanceled()

Returns true if the process was canceled (terminated/deleted) by the requester.

Returns:

true if the process was canceled (terminated/deleted) by the requester. false otherwise.

getClientJid

java.lang.String getClientJid()

Returns the JID of the requester.

Returns:

the JID of the requester.