Interface AppointmentSearchOrder

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

An interface for specifying the ordering of search results.

  • Method Details

    • orderByPerson

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

    • supportsPersonSearchOrder

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

    • getPersonSearchOrder

      PersonSearchOrder getPersonSearchOrder()
      Gets the person search order.
      Returns:
      the person search order
      Throws:
      UnimplementedException - supportsPersonSearchOrder() is false
      Compliance:
      optional - This method must be implemented if {@code supportsPersonSearchOrder()} is {@code true} .

    • orderByPosition

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

    • supportsPositionSearchOrder

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

    • getPositionSearchOrder

      PositionSearchOrder getPositionSearchOrder()
      Gets the position search order.
      Returns:
      the position search order
      Throws:
      UnimplementedException - supportsPositionSearchOrder() is false
      Compliance:
      optional - This method must be implemented if {@code supportsPositionSearchOrder()} is {@code true} .

    • orderByCommitment

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

    • orderByTitle

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

    • orderBySalary

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

    • getAppointmentSearchOrderRecord

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