Interface PoolProcessorSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface PoolProcessorSearchResults
extends OsidSearchResults

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

Method Summary

Modifier and Type	Method	Description
PoolProcessorQueryInspector	getPoolProcessorQueryInspector()	Gets the inspector for the query to examine the terms used in the search.
PoolProcessorList	getPoolProcessors()	Gets the PoolProcessorList resulting from a search.
PoolProcessorSearchResultsRecord	getPoolProcessorSearchResultsRecord(Type poolProcessorSearchRecordType)	Gets the pool processor search results record corresponding to the given pool processor search record Type .This method must be used to retrieve an object implementing the requested record.

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

getPoolProcessors

PoolProcessorList getPoolProcessors()

Gets the PoolProcessorList resulting from a search.

Returns:

the pool processor list

Throws:

IllegalStateException - list has already been retrieved

Compliance:

mandatory - This method must be implemented.

getPoolProcessorQueryInspector

PoolProcessorQueryInspector getPoolProcessorQueryInspector()

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

Returns:

the pool processor query inspector

Compliance:

mandatory - This method must be implemented.

getPoolProcessorSearchResultsRecord

PoolProcessorSearchResultsRecord getPoolProcessorSearchResultsRecord(Type poolProcessorSearchRecordType)
                                                              throws OperationFailedException,
PermissionDeniedException

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

Parameters:

poolProcessorSearchRecordType - a pool processor search record type

Returns:

the pool processor search results record

Throws:

NullArgumentException - poolProcessorSearchRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - hasRecordType(poolProcessorSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.