Interface Pool

All Superinterfaces:
Browsable, Extensible, Identifiable, Operable, OsidGovernator, OsidObject, Subjugateable
public interface Pool extends OsidGovernator, Subjugateable

A Pool represents a set of Resources to be provisioned. The rule indicates how resources are provisioned.

  • Method Details

    • getBrokerId

      Id getBrokerId()
      Gets the broker Id .
      Returns:
      the broker Id
      Compliance:
      mandatory - This method must be implemented.

    • getBroker

      Broker getBroker() throws OperationFailedException
      Gets the broker.
      Returns:
      the broker
      Throws:
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.

    • getSupplierIds

      IdList getSupplierIds()
      Gets the Ids of the suppliers.
      Returns:
      the supplier Ids
      Compliance:
      mandatory - This method must be implemented.

    • getSuppliers

      ResourceList getSuppliers() throws OperationFailedException
      Gets the suppliers.
      Returns:
      the suppliers
      Throws:
      OperationFailedException - unable to complete request
      Compliance:
      mandatory - This method must be implemented.

    • hasSize

      boolean hasSize()
      Tests if a pool size is available.
      Returns:
      true if a queue size is available, false otherwise
      Compliance:
      mandatory - This method must be implemented.

    • getSize

      long getSize()
      Gets the size of the pool.
      Returns:
      the size
      Throws:
      IllegalStateException - hasSize() is false
      Compliance:
      mandatory - This method must be implemented.

    • getPoolRecord

      PoolRecord getPoolRecord(Type poolRecordType) throws OperationFailedException
      Gets the pool record corresponding to the given Pool record Type .This method is used to retrieve an object implementing the requested record. The poolRecordType may be the Type returned in getRecordTypes() or any of its parents in a Type hierarchy where hasRecordType(poolRecordType) is true .
      Parameters:
      poolRecordType - the type of pool record to retrieve
      Returns:
      the pool record
      Throws:
      NullArgumentException - poolRecordType is null
      OperationFailedException - unable to complete request
      UnsupportedException - hasRecordType(poolRecordType) is false
      Compliance:
      mandatory - This method must be implemented.