Interface InquiryForm

All Superinterfaces:
Extensible, Identifiable, OsidBrowsableForm, OsidExtensibleForm, OsidForm, OsidIdentifiableForm, OsidObjectForm, OsidOperableForm, OsidRuleForm, OsidSubjugateableForm, Suppliable
All Known Subinterfaces:
InquiryBatchForm
public interface InquiryForm extends OsidRuleForm, OsidSubjugateableForm

This is the form for creating and updating Inquiries. Like all OsidForms, various data elements may be set here for use in the create and update methods in the InquiryAdminSession. For each data element that may be set, metadata may be examined to provide display hints or data constraints.

Like all OsidForms, InquiryForm is stateful and must not be accessed by multiple processing threads.

  • Method Details

    • getAuditorsMetadata

      Metadata getAuditorsMetadata()
      Gets the metadata for the auditors.
      Returns:
      metadata for the auditors
      Compliance:
      mandatory - This method must be implemented.

    • setAuditors

      void setAuditors(IdList auditorIds)
      Sets the auditors.
      Parameters:
      auditorIds - the new auditors
      Throws:
      InvalidArgumentException - auditorIds is invalid
      NoAccessException - Metadata.isReadOnly() is true
      NullArgumentException - auditorIds is null
      Compliance:
      mandatory - This method must be implemented.

    • clearAuditors

      void clearAuditors()
      Removes the auditors.
      Throws:
      NoAccessException - Metadata.isRequired() is true or Metadata.isReadOnly() is true
      Compliance:
      mandatory - This method must be implemented.

    • getQuestionMetadata

      Metadata getQuestionMetadata()
      Gets the metadata for the question.
      Returns:
      metadata for the question
      Compliance:
      mandatory - This method must be implemented.

    • setQuestion

      void setQuestion(String question)
      Sets the question.
      Parameters:
      question - the new question
      Throws:
      InvalidArgumentException - question is invalid
      NoAccessException - Metadata.isReadOnly() is true
      NullArgumentException - question is null
      Compliance:
      mandatory - This method must be implemented.

    • clearQuestion

      void clearQuestion()
      Removes the question.
      Throws:
      NoAccessException - Metadata.isRequired() is true or Metadata.isReadOnly() is true
      Compliance:
      mandatory - This method must be implemented.

    • getRequiredMetadata

      Metadata getRequiredMetadata()
      Gets the metadata for the required flag.
      Returns:
      metadata for the required flag
      Compliance:
      mandatory - This method must be implemented.

    • setRequired

      void setRequired(boolean required)
      Sets the required flag.
      Parameters:
      required - true is the inquiry requires a response, false if optional
      Throws:
      InvalidArgumentException - required is invalid
      NoAccessException - Metadata.isReadOnly() is true
      Compliance:
      mandatory - This method must be implemented.

    • clearRequired

      void clearRequired()
      Removes the required flag.
      Throws:
      NoAccessException - Metadata.isRequired() is true or Metadata.isReadOnly() is true
      Compliance:
      mandatory - This method must be implemented.

    • getAffirmationRequiredMetadata

      Metadata getAffirmationRequiredMetadata()
      Gets the metadata for the affirmation required flag.
      Returns:
      metadata for the required flag
      Compliance:
      mandatory - This method must be implemented.

    • setAffirmationRequired

      void setAffirmationRequired(boolean required)
      Sets the affirmation required flag.
      Parameters:
      required - true if a positive response is required, false if a negative response is also acceptable
      Throws:
      InvalidArgumentException - required is invalid
      NoAccessException - Metadata.isReadOnly() is true
      Compliance:
      mandatory - This method must be implemented.

    • clearAffirmationRequired

      void clearAffirmationRequired()
      Removes the affirmation required flag.
      Throws:
      NoAccessException - Metadata.isRequired() is true or Metadata.isReadOnly() is true
      Compliance:
      mandatory - This method must be implemented.

    • getNeedsOneResponseMetadata

      Metadata getNeedsOneResponseMetadata()
      Gets the metadata for the needs one response flag.
      Returns:
      metadata for the needs one response flag
      Compliance:
      mandatory - This method must be implemented.

    • setNeedsOneResponse

      void setNeedsOneResponse(boolean one)
      Sets the needs one response flag.
      Parameters:
      one - true if only one effective response is needed,, false if the inquiry should be performed each time
      Throws:
      InvalidArgumentException - one is invalid
      NoAccessException - Metadata.isReadOnly() is true
      Compliance:
      mandatory - This method must be implemented.

    • clearNeedsOneResponse

      void clearNeedsOneResponse()
      Removes the needs one response flag.
      Throws:
      NoAccessException - Metadata.isRequired() is true or Metadata.isReadOnly() is true
      Compliance:
      mandatory - This method must be implemented.

    • getInquiryFormRecord

      InquiryFormRecord getInquiryFormRecord(Type inquiryRecordType) throws OperationFailedException
      Gets the InquiryFormRecord corresponding to the given inquiry record Type.
      Parameters:
      inquiryRecordType - an inquiry record type
      Returns:
      the inquiry form record
      Throws:
      NullArgumentException - inquiryRecordType is null
      OperationFailedException - unable to complete request
      UnsupportedException - hasRecordType(inquiryRecordType) is false
      Compliance:
      mandatory - This method must be implemented.