OSID Logo
OSID Specifications
transport package
Version 3.0.0
Release Candidate Preview
Interfaceosid.transport.Response
Implementsosid.OsidObject
Description

A Response represents a stuctured response from a service endpoint.

Methodok
Description

Tests if the request was successful.

Returnboolean true if the request was successful, false otherrwise
CompliancemandatoryThis method must be implemented.
MethodgetStatusMessage
Description

Gets a status message. The returned string may be empty or may contain an error message is an error occurred.

Returnosid.locale.DisplayTextan error message
CompliancemandatoryThis method must be implemented.
MethodgetResponseRecord
Description

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

Parametersosid.type.TyperesponseRecordTypea response record type
Returnosid.transport.records.ResponseRecordthe response record
ErrorsNULL_ARGUMENT responseMessageType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(responseRecordType) is false
CompliancemandatoryThis method must be implemented.