org.osid.provisioning.rules

Interface PoolProcessor

All Superinterfaces:

Browsable, Extensible, Identifiable, Operable, OsidObject, OsidProcessor, OsidRule

public interface PoolProcessor
extends OsidProcessor

A PoolProcessor describes the rules for managing resource allocations out of a pool.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	allocatesByLeastCost() Tests if allocations prefer the cheapest provisionables.
boolean	allocatesByLeastUse() Tests if allocations balance the usage by preferring the least used provisionables in the pool.
boolean	allocatesByMostCost() Tests if allocations prefer the most expensive provisionables.
boolean	allocatesByMostUse() Tests if allocations prefer the most used provisionables in the pool.
PoolProcessorRecord	getPoolProcessorRecord(Type poolProcessorRecordType) Gets the pool processor record corresponding to the given PoolProcessor record Type.

Methods inherited from interface org.osid.OsidRule

getRule, getRuleId, hasRule

Methods inherited from interface org.osid.OsidObject

getDescription, getDisplayName, getGenusType, isOfGenusType

Methods inherited from interface org.osid.Identifiable

getId, isCurrent

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.Browsable

getProperties, getPropertiesByRecordType

Methods inherited from interface org.osid.Operable

isActive, isDisabled, isEnabled, isOperational

Method Detail

allocatesByLeastUse

boolean allocatesByLeastUse()

Tests if allocations balance the usage by preferring the least used provisionables in the pool.

Returns:

true if the least used provisionables are preferred, false otherwise

Compliance:

mandatory - This method must be implemented.

allocatesByMostUse

boolean allocatesByMostUse()

Tests if allocations prefer the most used provisionables in the pool.

Returns:

true if the most used provisionables are preferred, false otherwise

Compliance:

mandatory - This method must be implemented.

allocatesByLeastCost

boolean allocatesByLeastCost()

Tests if allocations prefer the cheapest provisionables.

Returns:

true if the cheapest provisionables are preferred, false otherwise

Compliance:

mandatory - This method must be implemented.

allocatesByMostCost

boolean allocatesByMostCost()

Tests if allocations prefer the most expensive provisionables.

Returns:

true if the most expensive provisionables are prefsrred, false otherwise

Compliance:

mandatory - This method must be implemented.

getPoolProcessorRecord

PoolProcessorRecord getPoolProcessorRecord(Type poolProcessorRecordType)
                                           throws OperationFailedException

Gets the pool processor record corresponding to the given PoolProcessor record Type. This method is used to retrieve an object implementing the requested record. The poolProcessorRecordType may be the Type returned in getRecordTypes() or any of its parents in a Type hierarchy where hasRecordType(poolProcessorRecordType) is true .

Parameters:

poolProcessorRecordType - the type of pool processor record to retrieve

Returns:

the pool processor record

Throws:

NullArgumentException - poolProcessorRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(poolProcessorRecordType) is false

Compliance:

mandatory - This method must be implemented.