Interface PoolProcessorEnablerSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface PoolProcessorEnablerSearchResults
extends OsidSearchResults

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

Method Summary

Modifier and Type	Method	Description
PoolProcessorEnablerQueryInspector	getPoolProcessorEnablerQueryInspector()	Gets the inspector for the query to examine the terms used in the search.
PoolProcessorEnablerList	getPoolProcessorEnablers()	Gets the PoolProcessorEnablerList resulting from a search.
PoolProcessorEnablerSearchResultsRecord	getPoolProcessorEnablerSearchResultsRecord(Type poolProcessorEnablerSearchRecordType)	Gets the pool processor enabler search results record corresponding to the given pool processor enabler 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

getPoolProcessorEnablers

PoolProcessorEnablerList getPoolProcessorEnablers()

Gets the PoolProcessorEnablerList resulting from a search.

Returns:

the pool processor enabler list

Throws:

IllegalStateException - list has already been retrieved

Compliance:

mandatory - This method must be implemented.

getPoolProcessorEnablerQueryInspector

PoolProcessorEnablerQueryInspector getPoolProcessorEnablerQueryInspector()

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

Returns:

the pool processor enabler query inspector

Compliance:

mandatory - This method must be implemented.

getPoolProcessorEnablerSearchResultsRecord

PoolProcessorEnablerSearchResultsRecord getPoolProcessorEnablerSearchResultsRecord(Type poolProcessorEnablerSearchRecordType)
                                                                            throws OperationFailedException,
PermissionDeniedException

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

Parameters:

poolProcessorEnablerSearchRecordType - a pool processor enabler search record type

Returns:

the pool processor enabler search results record

Throws:

NullArgumentException - poolProcessorEnablerSearchRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - hasRecordType(poolProcessorEnablerSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.