Interface PoolProcessor
- All Superinterfaces:
Browsable, Extensible, Identifiable, Operable, OsidObject, OsidProcessor, OsidRule
A PoolProcessor describes the rules for managing resource
allocations out of a pool.
-
Method Summary
Modifier and TypeMethodDescriptionbooleanTests if allocations prefer the cheapest provisionables.booleanTests if allocations balance the usage by preferring the least used provisionables in the pool.booleanTests if allocations prefer the most expensive provisionables.booleanTests if allocations prefer the most used provisionables in the pool.getPoolProcessorRecord(Type poolProcessorRecordType) Gets the pool processor record corresponding to the givenPoolProcessorrecordType.Methods inherited from interface Browsable
getProperties, getPropertiesByRecordTypeModifier and TypeMethodDescriptionGets a list of properties.getPropertiesByRecordType(Type recordType) Gets a list of properties corresponding to the specified record type.Methods inherited from interface Extensible
getRecordTypes, hasRecordTypeModifier and TypeMethodDescriptionGets the record types available in this object.booleanhasRecordType(Type recordType) Tests if this object supports the given recordType.Methods inherited from interface Identifiable
getId, isCurrentMethods inherited from interface Operable
isActive, isDisabled, isEnabled, isOperationalModifier and TypeMethodDescriptionbooleanisActive()Tests if this operable is active.booleanTests if this operable is administravely disabled.booleanTests if this operable is administravely enabled.booleanTests if thisOperableis operational.Methods inherited from interface OsidObject
getDescription, getDisplayName, getGenusType, isOfGenusTypeModifier and TypeMethodDescriptionGets the description associated with this instance of this OSID object.Gets the preferred display name associated with this instance of this OSID object appropriate for display to the user.Gets the genus type of this object.booleanisOfGenusType(Type genusType) Tests if this object is of the given genusType.Methods inherited from interface OsidRule
getConditionRecordTypes, getRule, getRuleId, hasRule
-
Method Details
-
allocatesByLeastUse
boolean allocatesByLeastUse()Tests if allocations balance the usage by preferring the least used provisionables in the pool.- Returns:
trueif the least used provisionables are preferred,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
allocatesByMostUse
boolean allocatesByMostUse()Tests if allocations prefer the most used provisionables in the pool.- Returns:
trueif the most used provisionables are preferred,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
allocatesByLeastCost
boolean allocatesByLeastCost()Tests if allocations prefer the cheapest provisionables.- Returns:
trueif the cheapest provisionables are preferred,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
allocatesByMostCost
boolean allocatesByMostCost()Tests if allocations prefer the most expensive provisionables.- Returns:
trueif the most expensive provisionables are prefsrred,falseotherwise- Compliance:
mandatory- This method must be implemented.
-
getPoolProcessorRecord
PoolProcessorRecord getPoolProcessorRecord(Type poolProcessorRecordType) throws OperationFailedException Gets the pool processor record corresponding to the givenPoolProcessorrecordType. This method is used to retrieve an object implementing the requested record. ThepoolProcessorRecordTypemay be theTypereturned ingetRecordTypes()or any of its parents in aTypehierarchy wherehasRecordType(poolProcessorRecordType)istrue.- Parameters:
poolProcessorRecordType- the type of pool processor record to retrieve- Returns:
- the pool processor record
- Throws:
NullArgumentException-poolProcessorRecordTypeisnullOperationFailedException- unable to complete requestUnsupportedException-hasRecordType(poolProcessorRecordType)isfalse- Compliance:
mandatory- This method must be implemented.
-