Interface ResourceSearchOrder

All Superinterfaces:
Extensible, OsidBrowsableSearchOrder, OsidExtensibleSearchOrder, OsidIdentifiableSearchOrder, OsidObjectSearchOrder, OsidSearchOrder, Suppliable
public interface ResourceSearchOrder extends OsidObjectSearchOrder

An interface for specifying the ordering of search results.

  • Method Details

    • orderByGroup

      void orderByGroup(SearchOrderStyle style)
      Groups the search results by resources that are groups.
      Parameters:
      style - search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • orderByDemographic

      void orderByDemographic(SearchOrderStyle style)
      Groups the search results by resources that are demographics.
      Parameters:
      style - search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • orderByAvatar

      void orderByAvatar(SearchOrderStyle style)
      Orders the result set by avatar.
      Parameters:
      style - search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • supportsAvatarSearchOrder

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

    • getAvatarSearchOrder

      AssetSearchOrder getAvatarSearchOrder()
      Gets the search order for an asset.
      Returns:
      the asset search order
      Throws:
      UnimplementedException - supportsAvatarSearchOrder() is false
      Compliance:
      optional - This method must be implemented if {@code supportsAvatarSearchOrder()} is {@code true}.

    • getResourceSearchOrderRecord

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