org.osid.provisioning.rules

Interface PoolConstrainerEnablerSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface PoolConstrainerEnablerSearchResults
extends OsidSearchResults

This interface provides a means to capture results of a search.

Method Summary

Methods

Modifier and Type	Method and Description
PoolConstrainerEnablerQueryInspector	getPoolConstrainerEnablerQueryInspector() Gets the inspector for the query to examine the terms used in the search.
PoolConstrainerEnablerList	getPoolConstrainerEnablers() Gets the PoolConstrainerEnablerList resulting from a search.
PoolConstrainerEnablerSearchResultsRecord	getPoolConstrainerEnablerSearchResultsRecord(Type poolConstrainerEnablerSearchRecordType) Gets the pool constrainer enabler search results record corresponding to the given pool constrainer enabler search record Type.

Methods inherited from interface org.osid.OsidSearchResults

getResultSize

Methods inherited from interface org.osid.Extensible

getRecordTypes, hasRecordType

Methods inherited from interface org.osid.Browsable

getProperties, getPropertiesByRecordType

Method Detail

getPoolConstrainerEnablers

PoolConstrainerEnablerList getPoolConstrainerEnablers()

Gets the PoolConstrainerEnablerList resulting from a search.

Returns:

the pool constrainer enabler list

Throws:

IllegalStateException - list has already been retrieved

Compliance:

mandatory - This method must be implemented.

getPoolConstrainerEnablerQueryInspector

PoolConstrainerEnablerQueryInspector getPoolConstrainerEnablerQueryInspector()

Gets the inspector for the query to examine the terms used in the search.

Returns:

the pool constrainer enabler query inspector

Compliance:

mandatory - This method must be implemented.

getPoolConstrainerEnablerSearchResultsRecord

PoolConstrainerEnablerSearchResultsRecord getPoolConstrainerEnablerSearchResultsRecord(Type poolConstrainerEnablerSearchRecordType)
                                                                                       throws OperationFailedException,
                                                                                              PermissionDeniedException

Gets the pool constrainer enabler search results record corresponding to the given pool constrainer enabler search record Type. This method must be used to retrieve an object implementing the requested record.

Parameters:

poolConstrainerEnablerSearchRecordType - a pool constrainer enabler search record type

Returns:

the pool constrainer enabler search results record

Throws:

NullArgumentException - poolConstrainerEnablerSearchRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - hasRecordType(poolConstrainerEnablerSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.