Interface ProgramOfferingSearchOrder

All Superinterfaces:
Extensible, OsidBrowsableSearchOrder, OsidExtensibleSearchOrder, OsidIdentifiableSearchOrder, OsidObjectSearchOrder, OsidRelationshipSearchOrder, OsidSearchOrder, OsidTemporalSearchOrder, Suppliable
public interface ProgramOfferingSearchOrder extends OsidRelationshipSearchOrder

An interface for specifying the ordering of search results.

  • Method Details

    • orderByProgram

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

    • supportsProgramSearchOrder

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

    • getProgramSearchOrder

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

    • orderByTerm

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

    • supportsTermSearchOrder

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

    • getTermSearchOrder

      TermSearchOrder getTermSearchOrder()
      Gets the term order.
      Returns:
      the term search order
      Throws:
      UnimplementedException - supportsTermSearchOrder() is false
      Compliance:
      optional - This method must be implemented if {@code supportsTermSearchOrder()} is {@code true} .

    • orderByTitle

      void orderByTitle(SearchOrderStyle style)
      Specifies a preference for ordering the result set by program offering 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 offering number.
      Parameters:
      style - a search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • orderByParentProgramOffering

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

    • supportsParentProgramOfferingSearchOrder

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

    • getParentProgramOfferingSearchOrder

      ProgramOfferingSearchOrder getParentProgramOfferingSearchOrder()
      Gets the parent program offering search order.
      Returns:
      the program offering search order
      Throws:
      UnimplementedException - supportsParentProgramOfferingSearchOrder() is false
      Compliance:
      optional - This method must be implemented if {@code supportsParentProgramOfferingSearchOrder()} 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.

    • orderByRequiresRegistration

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

    • orderByMinimumSeats

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

    • orderByMaximumSeats

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

    • orderByURL

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

    • getProgramOfferingSearchOrderRecord

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