Interface InstructionSearchOrder

All Superinterfaces:
Extensible, OsidBrowsableSearchOrder, OsidEnablerSearchOrder, OsidExtensibleSearchOrder, OsidIdentifiableSearchOrder, OsidObjectSearchOrder, OsidOperableSearchOrder, OsidRelationshipSearchOrder, OsidRuleApplicatorSearchOrder, OsidRuleSearchOrder, OsidSearchOrder, OsidTemporalSearchOrder, Suppliable
public interface InstructionSearchOrder extends OsidRelationshipSearchOrder, OsidRuleApplicatorSearchOrder

An interface for specifying the ordering of search results.

  • Method Details

    • orderByAgenda

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

    • supportsAgendaSearchOrder

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

    • getAgendaSearchOrder

      AgendaSearchOrder getAgendaSearchOrder()
      Gets the agenda search order.
      Returns:
      the agenda search order
      Throws:
      IllegalStateException - supportsAgendaSearchOrder() is false
      Compliance:
      mandatory - This method must be implemented.

    • orderByCheck

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

    • supportsCheckSearchOrder

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

    • getCheckSearchOrder

      CheckSearchOrder getCheckSearchOrder()
      Gets the check search order.
      Returns:
      the check search order
      Throws:
      IllegalStateException - supportsCheckSearchOrder() is false
      Compliance:
      mandatory - This method must be implemented.

    • orderByMessage

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

    • orderByWarning

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

    • orderByContinueOnFail

      void orderByContinueOnFail(SearchOrderStyle style)
      Orders the results by the continue-on-fail flag.
      Parameters:
      style - search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • orderByBreakOnSuccess

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

    • orderByOrder

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

    • getInstructionSearchOrderRecord

      InstructionSearchOrderRecord getInstructionSearchOrderRecord(Type instructionRecordType) throws OperationFailedException, PermissionDeniedException
      Gets the instruction search order record corresponding to the given instruction record Type . Multiple retrievals return the same underlying object.
      Parameters:
      instructionRecordType - an instruction record type
      Returns:
      the instruction search order record
      Throws:
      NullArgumentException - instructionRecordType is null
      OperationFailedException - unable to complete request
      PermissionDeniedException - authorization failure occurred
      UnsupportedException - hasRecordType(instructionRecordType) is false
      Compliance:
      mandatory - This method must be implemented.