org.osid.configuration.rules

Interface ParameterProcessorEnablerSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface ParameterProcessorEnablerSearchResults
extends OsidSearchResults

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

Method Summary

Methods

Modifier and Type	Method and Description
ParameterProcessorEnablerQueryInspector	getParameterProcessorEnablerQueryInspector() Gets the inspector for the query to examine the terms used in the search.
ParameterProcessorEnablerList	getParameterProcessorEnablers() Gets the ParameterProcessorEnablerList resulting from a search.
ParameterProcessorEnablerSearchResultsRecord	getParameterProcessorEnablerSearchResultsRecord(Type parameterProcessorEnablerSearchRecordType) Gets the parameter processor enabler search results record corresponding to the given parameter processor 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

getParameterProcessorEnablers

ParameterProcessorEnablerList getParameterProcessorEnablers()

Gets the ParameterProcessorEnablerList resulting from a search.

Returns:

the parameter processor enabler list

Throws:

IllegalStateException - list has already been retrieved

Compliance:

mandatory - This method must be implemented.

getParameterProcessorEnablerQueryInspector

ParameterProcessorEnablerQueryInspector getParameterProcessorEnablerQueryInspector()

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

Returns:

the parameter processor enabler query inspector

Compliance:

mandatory - This method must be implemented.

getParameterProcessorEnablerSearchResultsRecord

ParameterProcessorEnablerSearchResultsRecord getParameterProcessorEnablerSearchResultsRecord(Type parameterProcessorEnablerSearchRecordType)
                                                                                             throws OperationFailedException,
                                                                                                    PermissionDeniedException

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

Parameters:

parameterProcessorEnablerSearchRecordType - a parameter processor enabler search record type

Returns:

the parameter processor enabler search results record

Throws:

NullArgumentException - parameterProcessorEnablerSearchRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - hasRecordType(parameterProcessorEnablerSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.