Interface CommissionSearchOrder

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

An interface for specifying the ordering of search results.

  • Method Details

    • orderByResource

      void orderByResource(SearchOrderStyle style)
      Orders the results by resource.
      Parameters:
      style - search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • supportsResourceSearchOrder

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

    • getResourceSearchOrder

      ResourceSearchOrder getResourceSearchOrder()
      Gets the resource search order.
      Returns:
      the resource search order
      Throws:
      IllegalStateException - supportsResourceSearchOrder() is false
      Compliance:
      mandatory - This method must be implemented.

    • orderByWork

      void orderByWork(SearchOrderStyle style)
      Orders the results by work.
      Parameters:
      style - search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • supportsWorkSearchOrder

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

    • getWorkSearchOrder

      WorkSearchOrder getWorkSearchOrder()
      Gets the work search order.
      Returns:
      the work search order
      Throws:
      IllegalStateException - supportsWorkSearchOrder() is false
      Compliance:
      mandatory - This method must be implemented.

    • orderByCompetency

      void orderByCompetency(SearchOrderStyle style)
      Orders the results by competency.
      Parameters:
      style - search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • supportsCompetencySearchOrder

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

    • getCompetencySearchOrder

      CompetencySearchOrder getCompetencySearchOrder()
      Gets the competency search order.
      Returns:
      the competency search order
      Throws:
      IllegalStateException - supportsCompetencySearchOrder() is false
      Compliance:
      mandatory - This method must be implemented.

    • orderByPercentage

      void orderByPercentage(SearchOrderStyle style)
      Orders the results by percentage availability.
      Parameters:
      style - search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • getCommissionSearchOrderRecord

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