OSID Logo
OSID Specifications
inquiry package
Version 3.0.0
Release Candidate Preview
Interfaceosid.inquiry.Response
Implementsosid.OsidRelationship
Description

A Response to an Inquiry . A Response is an OsidRelationship between an Inquiry and a Resource.

MethodgetInquiryId
Description

Gets the inquiry Id.

Returnosid.id.Idthe inquiry Id
CompliancemandatoryThis method must be implemented.
MethodgetInquiry
Description

Gets the inquiry.

Returnosid.inquiry.Inquirythe inquiry
ErrorsOPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetResponderId
Description

Gets the responder resource Id.

Returnosid.id.Idthe resource Id
CompliancemandatoryThis method must be implemented.
MethodgetResponder
Description

Gets the responder resource.

Returnosid.resource.Resourcethe resource
ErrorsOPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetRespondingAgentId
Description

Gets the responding agent Id.

Returnosid.id.Idthe agent Id
CompliancemandatoryThis method must be implemented.
MethodgetRespondingAgent
Description

Gets the responding agent.

Returnosid.authentication.Agentthe agent
ErrorsOPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodisAffirmative
Description

Tests if this response was affirmative.

Returnboolean true if affirmative, false if negative
CompliancemandatoryThis method must be implemented.
MethodgetResponseRecord
Description

Gets the response record corresponding to the given Response record Type. This method is used to retrieve an object implementing the requested record. The responseRecordType may be the Type returned in getRecordTypes() or any of its parents in a Type hierarchy where hasRecordType(responseRecordType) is true .

Parametersosid.type.TyperesponseRecordTypethe type of response record to retrieve
Returnosid.inquiry.records.ResponseRecordthe response record
ErrorsNULL_ARGUMENT responseRecordType is null
OPERATION_FAILEDunable to complete request
UNSUPPORTED hasRecordType(responseRecordType) is false
CompliancemandatoryThis method must be implemented.