Interface ParameterProcessorEnablerSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface ParameterProcessorEnablerSearch
extends OsidSearch

The search for governing parameter processor enabler searches.

Method Summary

Modifier and Type	Method	Description
ParameterProcessorEnablerSearchRecord	getParameterProcessorEnablerSearchRecord(Type parameterProcessorEnablerSearchRecordType)	Gets the parameter processor enabler search record corresponding to the given parameter processor enabler search record Type.
void	orderParameterProcessorEnablerResults(ParameterProcessorEnablerSearchOrder parameterProcessorEnablerSearchOrder)	Specify an ordering to the search results.
void	searchAmongParameterProcessorEnablers(IdList parameterProcessorEnablerIds)	Execute this search among the given list of parameter processor enablers.

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 OsidSearch

limitResultSet

Modifier and Type	Method	Description
void	limitResultSet(long start, long end)	By default, searches return all matching results.

Method Details

searchAmongParameterProcessorEnablers

void searchAmongParameterProcessorEnablers(IdList parameterProcessorEnablerIds)

Execute this search among the given list of parameter processor enablers.

Parameters:

parameterProcessorEnablerIds - list of parameter processor enablers

Throws:

NullArgumentException - parameterProcessorEnablerIds is null

Compliance:

mandatory - This method must be implemented.

orderParameterProcessorEnablerResults

void orderParameterProcessorEnablerResults(ParameterProcessorEnablerSearchOrder parameterProcessorEnablerSearchOrder)

Specify an ordering to the search results.

Parameters:

parameterProcessorEnablerSearchOrder - parameter processor enabler search order

Throws:

NullArgumentException - parameterProcessorEnablerSearchOrder is null

UnsupportedException - parameterProcessorEnablerSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getParameterProcessorEnablerSearchRecord

ParameterProcessorEnablerSearchRecord getParameterProcessorEnablerSearchRecord(Type parameterProcessorEnablerSearchRecordType)
                                                                        throws OperationFailedException

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

Parameters:

parameterProcessorEnablerSearchRecordType - a parameter processor enabler search record type

Returns:

the parameter processor enabler search record

Throws:

NullArgumentException - parameterProcessorEnablerSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(parameterProcessorEnablerSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.