Interface ProgramSearchOrder

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

An interface for specifying the ordering of search results.

  • Method Details

    • orderByTitle

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

    • orderByNumber

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

    • orderByParentProgram

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

    • supportsParentProgramSearchOrder

      boolean supportsParentProgramSearchOrder()
      Tests if a parent program search order is available.
      Returns:
      true if a program search order is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getParentProgramSearchOrder

      ProgramSearchOrder getParentProgramSearchOrder()
      Gets the parent program search order.
      Returns:
      the program search order
      Throws:
      UnimplementedException - supportsParentProgramSearchOrder() is false
      Compliance:
      optional - This method must be implemented if {@code supportsParentProgramSearchOrder()} is {@code true} .

    • orderByCompletionRequirementsInfo

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

    • getProgramSearchOrderRecord

      ProgramSearchOrderRecord getProgramSearchOrderRecord(Type programRecordType) throws OperationFailedException
      Gets the program search order record corresponding to the given program record Type . Multiple retrievals return the same underlying object.
      Parameters:
      programRecordType - a program record type
      Returns:
      the program search order record
      Throws:
      NullArgumentException - programRecordType is null
      OperationFailedException - unable to complete request
      UnsupportedException - hasRecordType(programRecordType) is false
      Compliance:
      mandatory - This method must be implemented.