com.adobe.versioncue.nativecomm.host

Interface IRequest

public interface IRequest

Since:

CS5

Method Summary

Modifier and Type	Method and Description
java.lang.String	call()
IClient	client() Returns the client initiating the request.
void	fail(java.lang.String reasonCode, java.lang.String errMessage) Marks the request as failed.
NCMap	params() Returns the request parameters.
NCMap	results() Returns the results map.
void	setProgress(java.lang.String taskname, double progress) Update progress information for this request [0.0 ...
boolean	succeeded() Returns true if the request was processed successfully.

Method Detail

call

java.lang.String call()

Returns:

NativeService call name

params

NCMap params()

Returns the request parameters.

Returns:

the request parameters

results

NCMap results()

Returns the results map.

Returns:

the results map

client

IClient client()

Returns the client initiating the request.

Returns:

the client initiating the request

succeeded

boolean succeeded()

Returns true if the request was processed successfully. A request is considered not successful if either the fail() method was called or the IHostDelegate#execute(IRequest) method throws an exception.

Returns:

true if the request was processed successfully

fail

void fail(java.lang.String reasonCode,
          java.lang.String errMessage)

Marks the request as failed. The reason code and error message are transmitted to ncomm client and will result in an ncomm exception on the client side.

Parameters:

reasonCode - - error code

errMessage - - error message

setProgress

void setProgress(java.lang.String taskname,
                 double progress)
          throws ServiceAbortException

Update progress information for this request [0.0 ... 1.0]

Parameters:

taskname - the task currently being performed

progress - the new progress value [0.0 ... 1.0]

Throws:

ServiceAbortException - if the request was aborted