Interface Response

All Superinterfaces:
Browsable, Extensible, Identifiable, OsidObject, OsidRelationship, Temporal
public interface Response extends OsidRelationship

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

  • Method Details

    • getInquiryId

      Id getInquiryId()
      Gets the inquiry Id .
      Returns:
      the inquiry Id
      Compliance:
      mandatory - This method must be implemented.

    • getInquiry

      Inquiry getInquiry() throws OperationFailedException
      Gets the inquiry.
      Returns:
      the inquiry
      Throws:
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.

    • getResponderId

      Id getResponderId()
      Gets the responder resource Id .
      Returns:
      the resource Id
      Compliance:
      mandatory - This method must be implemented.

    • getResponder

      Resource getResponder() throws OperationFailedException
      Gets the responder resource.
      Returns:
      the resource
      Throws:
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.

    • getRespondingAgentId

      Id getRespondingAgentId()
      Gets the responding agent Id .
      Returns:
      the agent Id
      Compliance:
      mandatory - This method must be implemented.

    • getRespondingAgent

      Agent getRespondingAgent() throws OperationFailedException
      Gets the responding agent.
      Returns:
      the agent
      Throws:
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.

    • isAffirmative

      boolean isAffirmative()
      Tests if this response was affirmative.
      Returns:
      true if affirmative, false if negative
      Compliance:
      mandatory - This method must be implemented.

    • getResponseRecord

      ResponseRecord getResponseRecord(Type responseRecordType) throws OperationFailedException
      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 .
      Parameters:
      responseRecordType - the type of response record to retrieve
      Returns:
      the response record
      Throws:
      NullArgumentException - responseRecordType is null
      OperationFailedException - unable to complete request
      UnsupportedException - hasRecordType(responseRecordType) is false
      Compliance:
      mandatory - This method must be implemented.