Interface ParticipantSearchOrder

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

An interface for specifying the ordering of search results.

  • Method Details

    • orderByOffering

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

    • supportsOfferingSearchOrder

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

    • getOfferingSearchOrder

      OfferingSearchOrder getOfferingSearchOrder()
      Gets the offering search order.
      Returns:
      the offering search order
      Throws:
      UnimplementedException - supportsOfferingSearchOrder() is false
      Compliance:
      optional - This method must be implemented if {@code supportsOfferingSearchOrder()} is {@code true} .

    • orderByResource

      void orderByResource(SearchOrderStyle style)
      Specifies a preference for ordering the result set by the 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 an offering 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:
      UnimplementedException - supportsResourceSearchOrder() is false
      Compliance:
      optional - This method must be implemented if {@code supportsResourceSearchOrder()} is {@code true} .

    • orderByTimePeriod

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

    • supportsTimePeriodSearchOrder

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

    • getTimePeriodSearchOrder

      TimePeriodSearchOrder getTimePeriodSearchOrder()
      Gets the time period order.
      Returns:
      the time period search order
      Throws:
      UnimplementedException - supportsTimePeriodSearchOrder() is false
      Compliance:
      optional - This method must be implemented if {@code supportsTimePeriodSearchOrder()} is {@code true} .

    • getParticipantSearchOrderRecord

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