org.osid.provisioning.rules

Interface PoolConstrainerSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface PoolConstrainerSearchResults
extends OsidSearchResults

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

Method Summary

Methods

Modifier and Type	Method and Description
PoolConstrainerQueryInspector	getPoolConstrainerQueryInspector() Gets the inspector for the query to examine the terms used in the search.
PoolConstrainerList	getPoolConstrainers() Gets the PoolConstrainerList resulting from a search.
PoolConstrainerSearchResultsRecord	getPoolConstrainerSearchResultsRecord(Type poolConstrainerSearchRecordType) Gets the pool constrainer search results record corresponding to the given pool constrainer 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

getPoolConstrainers

PoolConstrainerList getPoolConstrainers()

Gets the PoolConstrainerList resulting from a search.

Returns:

the pool constrainer list

Throws:

IllegalStateException - list has already been retrieved

Compliance:

mandatory - This method must be implemented.

getPoolConstrainerQueryInspector

PoolConstrainerQueryInspector getPoolConstrainerQueryInspector()

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

Returns:

the pool constrainer query inspector

Compliance:

mandatory - This method must be implemented.

getPoolConstrainerSearchResultsRecord

PoolConstrainerSearchResultsRecord getPoolConstrainerSearchResultsRecord(Type poolConstrainerSearchRecordType)
                                                                         throws OperationFailedException,
                                                                                PermissionDeniedException

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

Parameters:

poolConstrainerSearchRecordType - a pool constrainer search record type

Returns:

the pool constrainer search results record

Throws:

NullArgumentException - poolConstrainerSearchRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - hasRecordType(poolConstrainerSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.