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

Modifier and Type	Method	Description
PoolConstrainerQueryInspector	getPoolConstrainerQueryInspector()	Gets the inspector for the query to examine the terms used in the search.
PoolConstrainerList	getPoolConstrainers()	Gets the pool constrainer list 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 Browsable

getProperties, getPropertiesByRecordType

Modifier and Type	Method	Description
PropertyList	getProperties()	Gets a list of properties.
PropertyList	getPropertiesByRecordType(Type recordType)	Gets a list of properties corresponding to the specified record type.

Methods inherited from interface Extensible

getRecordTypes, hasRecordType

Modifier and Type	Method	Description
TypeList	getRecordTypes()	Gets the record types available in this object.
boolean	hasRecordType(Type recordType)	Tests if this object supports the given record Type.

Methods inherited from interface OsidSearchResults

getResultSize

Modifier and Type	Method	Description
long	getResultSize()	Returns the size of a result set from a search query.

Method Details

getPoolConstrainers

PoolConstrainerList getPoolConstrainers()

Gets the pool constrainer list resulting from a search.

Returns:

the pool constrainer list

Throws:

IllegalStateException - list already 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

Gets the pool constrainer search results record corresponding to the given pool constrainer search record Type. This method is 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

UnsupportedException - hasRecordType(poolConstrainerSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.