Interface ConferralSearchOrder

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

An interface for specifying the ordering of search results.

  • Method Details

    • orderByAward

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

    • supportsAwardSearchOrder

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

    • getAwardSearchOrder

      AwardSearchOrder getAwardSearchOrder()
      Gets the award order.
      Returns:
      the award search order
      Throws:
      UnimplementedException - supportsAwardSearchOrder() is false
      Compliance:
      optional - This method must be implemented if {@code supportsAwardSearchOrder()} is {@code true} .

    • orderByRecipient

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

    • supportsRecipientSearchOrder

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

    • getRecipientSearchOrder

      ResourceSearchOrder getRecipientSearchOrder()
      Gets the recipient order.
      Returns:
      the resource search order
      Throws:
      UnimplementedException - supportsRecipientSearchOrder() is false
      Compliance:
      optional - This method must be implemented if {@code supportsRecipientSearchOrder()} is {@code true} .

    • orderByReference

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

    • orderByConvocation

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

    • supportsConvocationSearchOrder

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

    • getConvocationSearchOrder

      ConvocationSearchOrder getConvocationSearchOrder()
      Gets the convocation order.
      Returns:
      the convocation search order
      Throws:
      UnimplementedException - supportsConvocationSearchOrder() is false
      Compliance:
      optional - This method must be implemented if {@code supportsConvocationSearchOrder()} is {@code true} .

    • getConferralSearchOrderRecord

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