OSID Logo
OSID Specifications
transport package
Version 3.0.0
Release Candidate Preview
Interfaceosid.transport.Request
Implementsosid.Suppliable
osid.Extensible
Description

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.

MethodsetId
Description

Sets an identifier for this request.

Parametersosid.id.Ididan identifier
ErrorsNULL_ARGUMENT id is null
CompliancemandatoryThis method must be implemented.
MethodgetRequestRecord
Description

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

Parametersosid.type.TyperequestRecordTypea request record type
Returnosid.transport.records.RequestRecordthe request record
ErrorsNULL_ARGUMENT requestRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(requestType) is false
CompliancemandatoryThis method must be implemented.