Interface Response

All Superinterfaces:

Browsable, Extensible, Identifiable, OsidObject

public interface Response
extends OsidObject

A Response represents a stuctured response from a service endpoint.

Method Summary

Modifier and Type	Method	Description
ResponseRecord	getResponseRecord(Type responseRecordType)	Gets the response record.
DisplayText	getStatusMessage()	Gets a status message.
boolean	ok()	Tests if the request was successful.

Methods inherited from interface Browsable

getProperties, getPropertiesByRecordType

Modifier and Type	Method	Description
PropertyList	getProperties()	Gets a list of properties.
PropertyList	getPropertiesByRecordType(Type recordType)	Gets a list of properties corresponding to the specified record type.

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 .

Methods inherited from interface Identifiable

getId, isCurrent

Modifier and Type	Method	Description
Id	getId()	Gets the Id associated with this instance of this OSID object.
boolean	isCurrent()	Tests to see if the last method invoked retrieved up-to-date data.

Methods inherited from interface OsidObject

getDescription, getDisplayName, getGenusType, isOfGenusType

Modifier and Type	Method	Description
DisplayText	getDescription()	Gets the description associated with this instance of this OSID object.
DisplayText	getDisplayName()	Gets the preferred display name associated with this instance of this OSID object appropriate for display to the user.
Type	getGenusType()	Gets the genus type of this object.
boolean	isOfGenusType(Type genusType)	Tests if this object is of the given genus Type .

Method Details

ok

boolean ok()

Tests if the request was successful.

Returns:

true if the request was successful, false otherrwise

Compliance:

mandatory - This method must be implemented.

getStatusMessage

DisplayText getStatusMessage()

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

Returns:

an error message

Compliance:

mandatory - This method must be implemented.

getResponseRecord

ResponseRecord getResponseRecord(Type responseRecordType)
                          throws OperationFailedException

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

Parameters:

responseRecordType - a response record type

Returns:

the response record

Throws:

NullArgumentException - responseMessageType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(responseRecordType) is false

Compliance:

mandatory - This method must be implemented.