org.osid.provisioning.rules

Interface PoolConstrainerSearchOrder

All Superinterfaces:

Extensible, OsidBrowsableSearchOrder, OsidConstrainerSearchOrder, OsidExtensibleSearchOrder, OsidIdentifiableSearchOrder, OsidObjectSearchOrder, OsidOperableSearchOrder, OsidRuleSearchOrder, OsidSearchOrder, Suppliable

public interface PoolConstrainerSearchOrder
extends OsidConstrainerSearchOrder

An interface for specifying the ordering of search results.

Method Summary

Methods

Modifier and Type	Method and Description
PoolConstrainerSearchOrderRecord	getPoolConstrainerSearchOrderRecord(Type poolConstrainerRecordType) Gets the pool constrainer search order record corresponding to the given pool constrainer record Type.

Methods inherited from interface org.osid.OsidRuleSearchOrder

getRuleSearchOrder, orderByRule, supportsRuleSearchOrder

Methods inherited from interface org.osid.OsidObjectSearchOrder

orderByCreateTime, orderByCumulativeRating, orderByDescription, orderByDisplayName, orderByGenusType, orderByLastModifiedTime, orderByState, orderByStatistic

Methods inherited from interface org.osid.OsidIdentifiableSearchOrder

orderById

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.OsidOperableSearchOrder

orderByActive, orderByDisabled, orderByEnabled, orderByOperational

Method Detail

getPoolConstrainerSearchOrderRecord

PoolConstrainerSearchOrderRecord getPoolConstrainerSearchOrderRecord(Type poolConstrainerRecordType)
                                                                     throws OperationFailedException

Gets the pool constrainer search order record corresponding to the given pool constrainer record Type. Multiple retrievals return the same underlying object.

Parameters:

poolConstrainerRecordType - a pool constrainer record type

Returns:

the pool constrainer search order record

Throws:

NullArgumentException - poolConstrainerRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(poolConstrainerRecordType) is false

Compliance:

mandatory - This method must be implemented.