org.osid.provisioning.rules

Interface PoolConstrainer

All Superinterfaces:

Browsable, Extensible, Identifiable, Operable, OsidConstrainer, OsidObject, OsidRule

public interface PoolConstrainer
extends OsidConstrainer

A PoolConstrainer describes the rules for constraining the resources in a pool.

Method Summary

Methods

Modifier and Type	Method and Description
PoolConstrainerRecord	getPoolConstrainerRecord(Type poolConstrainerRecordType) Gets the pool constrainer record corresponding to the given PoolConstrainer 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

getPoolConstrainerRecord

PoolConstrainerRecord getPoolConstrainerRecord(Type poolConstrainerRecordType)
                                               throws OperationFailedException

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

Parameters:

poolConstrainerRecordType - the type of pool constrainer record to retrieve

Returns:

the pool constrainer record

Throws:

NullArgumentException - poolConstrainerRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(poolConstrainerRecordType) is false

Compliance:

mandatory - This method must be implemented.