Interface ContactSearchOrder

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

An interface for specifying the ordering of search results.

  • Method Details

    • 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.

    • orderByAddressee

      void orderByAddressee(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.

    • supportsAddresseeSearchOrder

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

    • getAddresseeSearchOrder

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

    • orderByAddress

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

    • supportsAddressSearchOrder

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

    • getAddressSearchOrder

      AddressSearchOrder getAddressSearchOrder()
      Gets the address order.
      Returns:
      the address search order
      Throws:
      UnimplementedException - supportsAddressSearchOrder() is false
      Compliance:
      optional - This method must be implemented if {@code supportsAddressSearchOrder()} is {@code true} .

    • getContactSearchOrderRecord

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