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

Modifier and Type	Method	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 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

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.