OSID Specifications
transport package
Version 3.1.0
transport package
Version 3.1.0
| Interface | osid.transport.Response | ||
|---|---|---|---|
| Implements | osid.OsidObject | ||
| Description |
A | ||
| Method | ok | ||
| Description |
Tests if the request was successful. | ||
| Return | boolean | true if the request was successful, false
otherrwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getStatusMessage | ||
| Description |
Gets a status message. The returned string may be empty or may contain an error message is an error occurred. | ||
| Return | osid.locale.DisplayText | an error message | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getResponseRecord | ||
| Description |
Gets the response record. This method is used to retrieve an object implementing the requested message. | ||
| Parameters | osid.type.Type | responseRecordType | a response record type |
| Return | osid.transport.records.ResponseRecord | the response record | |
| Errors | NULL_ARGUMENT | responseMessageType is null | |
| OPERATION_FAILED | unable to complete request | ||
| UNSUPPORTED | hasRecordType(responseRecordType) is false | ||
| Compliance | mandatory | This method must be implemented. | |