Request Methods

Request methods get information about requests or cancel requests made to the library.

cancelRequest()

Cancels a submitted request.

Used by STA.

Inputs	Outputs	Roles	Errors
long `requestId`	RequestDto	C2,S1,I	WebServiceException

getRequest()

Returns the status of a submitted request. This method allows the client to query for the completion status of an asynchronous operational request.

Used by STA.

Inputs	Outputs	Roles	Errors
long `requestId`	RequestDto	All	WebServiceException

getRequests()

Returns a list of requests ordered chronologically based on the request's createDateTime from newest to oldest.

If you specify null for firstTimeStamp, the library returns the newest "count" requests, otherwise the returned requests will be before firstTimeStamp.

Used by STA.

Inputs Outputs Roles Errors

Inputs	Outputs	Roles	Errors
int `count` XMLGregorianCalendar `firstTimeStamp`	List of RequestDto	All	WebServiceException

int count

XMLGregorianCalendar firstTimeStamp

List of RequestDto

All

WebServiceException

waitForRequest()

Waits for a submitted request to complete. Returns when the request completes or when the timeout expires.

Used by STA, ACSLS, and WWOPs.

Inputs Outputs Roles Errors

Inputs	Outputs	Roles	Errors
long `requestId`, int `timeout` (in seconds)	RequestDto	All	WebServiceException

long requestId,

int timeout (in seconds)

RequestDto

All

WebServiceException