Interface PoolProcessorSearchOrder

All Superinterfaces:
Extensible, OsidBrowsableSearchOrder, OsidExtensibleSearchOrder, OsidIdentifiableSearchOrder, OsidObjectSearchOrder, OsidOperableSearchOrder, OsidProcessorSearchOrder, OsidRuleSearchOrder, OsidSearchOrder, Suppliable
public interface PoolProcessorSearchOrder extends OsidProcessorSearchOrder

An interface for specifying the ordering of search results.

  • Method Details

    • orderByAllocatesByLeastUse

      void orderByAllocatesByLeastUse(SearchOrderStyle style)
      Orders the results by allocates by least use.
      Parameters:
      style - search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • orderByAllocatesByMostUse

      void orderByAllocatesByMostUse(SearchOrderStyle style)
      Orders the results by allocates by most use.
      Parameters:
      style - search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • orderByAllocatesByLeastCost

      void orderByAllocatesByLeastCost(SearchOrderStyle style)
      Orders the results by allocates by least cost.
      Parameters:
      style - search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • orderByAllocatesByMostCost

      void orderByAllocatesByMostCost(SearchOrderStyle style)
      Orders the results by allocates by most cost.
      Parameters:
      style - search order style
      Throws:
      NullArgumentException - style is null
      Compliance:
      mandatory - This method must be implemented.

    • getPoolProcessorSearchOrderRecord

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