Interface Request

All Superinterfaces:

Extensible, Suppliable

public interface Request
extends Suppliable, Extensible

A Request represents a stuctured request to a service endpoint. The record types supported may vary on a request by request basis as defined in the underlying protocol.

Method Summary

Modifier and Type	Method	Description
RequestRecord	getRequestRecord(Type requestRecordType)	Gets the request record.
void	setId(Id id)	Sets an identifier for this request.

Methods inherited from interface Extensible

getRecordTypes, hasRecordType

Modifier and Type	Method	Description
TypeList	getRecordTypes()	Gets the record types available in this object.
boolean	hasRecordType(Type recordType)	Tests if this object supports the given record Type .

Method Details

setId

void setId(Id id)

Sets an identifier for this request.

Parameters:

id - an identifier

Throws:

NullArgumentException - id is null

Compliance:

mandatory - This method must be implemented.

getRequestRecord

RequestRecord getRequestRecord(Type requestRecordType)
                        throws OperationFailedException

Gets the request record. This method is used to retrieve an object implementing the requested message.

Parameters:

requestRecordType - a request record type

Returns:

the request record

Throws:

NullArgumentException - requestRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(requestType) is false

Compliance:

mandatory - This method must be implemented.