Interface AssessmentPartSearchOrder

All Superinterfaces:
Extensible, OsidBrowsableSearchOrder, OsidContainableSearchOrder, OsidExtensibleSearchOrder, OsidIdentifiableSearchOrder, OsidObjectSearchOrder, OsidOperableSearchOrder, OsidSearchOrder, Suppliable
public interface AssessmentPartSearchOrder extends OsidObjectSearchOrder, OsidContainableSearchOrder, OsidOperableSearchOrder

An interface for specifying the ordering of search results.

  • Method Details

    • orderByAssessment

      void orderByAssessment(SearchOrderStyle style)
      Specifies a preference for ordering the result set by the assessment.
      Parameters:
      style - search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • supportsAssessmentSearchOrder

      boolean supportsAssessmentSearchOrder()
      Tests if an assessment search order is available.
      Returns:
      true if an assessment search order is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getAssessmentSearchOrder

      AssessmentSearchOrder getAssessmentSearchOrder()
      Gets the assessment order.
      Returns:
      the assessment search order
      Throws:
      UnimplementedException - supportsAssessmentSearchOrder() is false
      Compliance:
      optional - This method must be implemented if {@code supportsAssessmentSearchOrder()} is {@code true} .

    • orderBySection

      void orderBySection(SearchOrderStyle style)
      Specifies a preference for ordering the result set by the section.
      Parameters:
      style - search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • orderByWeight

      void orderByWeight(SearchOrderStyle style)
      Specifies a preference for ordering the result set by the weight.
      Parameters:
      style - search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • orderByAllocatedTime

      void orderByAllocatedTime(SearchOrderStyle style)
      Specifies a preference for ordering the result set by the allocated time.
      Parameters:
      style - search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • getAssessmentPartSearchOrderRecord

      AssessmentPartSearchOrderRecord getAssessmentPartSearchOrderRecord(Type assessmentPartRecordType) throws OperationFailedException
      Gets the assessment part search order record corresponding to the given assessment part record Type . Multiple retrievals return the same underlying object.
      Parameters:
      assessmentPartRecordType - an assessment part record type
      Returns:
      the assessment part search order record
      Throws:
      NullArgumentException - assessmentPartRecordType is null
      OperationFailedException - unable to complete request
      UnsupportedException - hasRecordType(assessmentPartRecordType) is false
      Compliance:
      mandatory - This method must be implemented.