OSID Logo
OSID Specifications
inquiry package
Version 3.1.0
Interfaceosid.inquiry.Response
Implementsosid.OsidRelationship
Used Byosid.inquiry.AcknowledgementSession
osid.inquiry.ResponseAdminSession
osid.inquiry.ResponseList
osid.inquiry.ResponseLookupSession
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.Id the inquiry Id
Compliancemandatory This method must be implemented.
MethodgetInquiry
Description

Gets the inquiry.

Returnosid.inquiry.Inquiry the inquiry
ErrorsOPERATION_FAILED unable to complete request
Compliancemandatory This method must be implemented.
MethodgetResponderId
Description

Gets the responder resource Id.

Returnosid.id.Id the resource Id
Compliancemandatory This method must be implemented.
MethodgetResponder
Description

Gets the responder resource.

Returnosid.resource.Resource the resource
ErrorsOPERATION_FAILED unable to complete request
Compliancemandatory This method must be implemented.
MethodgetRespondingAgentId
Description

Gets the responding agent Id.

Returnosid.id.Id the agent Id
Compliancemandatory This method must be implemented.
MethodgetRespondingAgent
Description

Gets the responding agent.

Returnosid.authentication.Agent the agent
ErrorsOPERATION_FAILED unable to complete request
Compliancemandatory This method must be implemented.
MethodisAffirmative
Description

Tests if this response was affirmative.

Returnboolean true if affirmative, false if negative
Compliancemandatory This 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.TyperesponseRecordType the type of response record to retrieve
Returnosid.inquiry.records.ResponseRecord the response record
ErrorsNULL_ARGUMENT responseRecordType is null
OPERATION_FAILED unable to complete request
UNSUPPORTED hasRecordType(responseRecordType) is false
Compliancemandatory This method must be implemented.