Interface CommitmentSearchOrder

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

An interface for specifying the ordering of search results.

  • Method Details

    • orderByEvent

      void orderByEvent(SearchOrderStyle style)
      Specified a preference for ordering results by the event.
      Parameters:
      style - a search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • supportsEventSearchOrder

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

    • getEventSearchOrder

      EventSearchOrder getEventSearchOrder()
      Gets the search order for an event.
      Returns:
      the event search order
      Throws:
      UnimplementedException - supportsEventSearchOrder() is false
      Compliance:
      optional - This method must be implemented if {@code supportsEventSearchOrder()} is {@code true} .

    • orderByResource

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

    • supportsResourceSearchOrder

      boolean supportsResourceSearchOrder()
      Tests if a ResourceSearchOrder 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 search order for a resource.
      Returns:
      the resource search order
      Throws:
      UnimplementedException - supportsResourceSearchOrder() is false
      Compliance:
      optional - This method must be implemented if {@code supportsResourceSearchOrder()} is {@code true} .

    • getCommitmentSearchOrderRecord

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