Interface ParameterProcessorSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface ParameterProcessorSearchResults
extends OsidSearchResults

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

Method Summary

Modifier and Type	Method	Description
ParameterProcessorQueryInspector	getParameterProcessorQueryInspector()	Gets the inspector for the query to examine the terms used in the search.
ParameterProcessorList	getParameterProcessors()	Gets the ParameterProcessorList resulting from a search.
ParameterProcessorSearchResultsRecord	getParameterProcessorSearchResultsRecord(Type parameterProcessorSearchRecordType)	Gets the parameter processor search results record corresponding to the given parameter processor 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

getParameterProcessors

ParameterProcessorList getParameterProcessors()

Gets the ParameterProcessorList resulting from a search.

Returns:

the parameter processor list

Throws:

IllegalStateException - list has already been retrieved

Compliance:

mandatory - This method must be implemented.

getParameterProcessorQueryInspector

ParameterProcessorQueryInspector getParameterProcessorQueryInspector()

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

Returns:

the parameter processor query inspector

Compliance:

mandatory - This method must be implemented.

getParameterProcessorSearchResultsRecord

ParameterProcessorSearchResultsRecord getParameterProcessorSearchResultsRecord(Type parameterProcessorSearchRecordType)
                                                                        throws OperationFailedException,
PermissionDeniedException

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

Parameters:

parameterProcessorSearchRecordType - a parameter processor search record type

Returns:

the parameter processor search results record

Throws:

NullArgumentException - parameterProcessorSearchRecordType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - hasRecordType(parameterProcessorSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.