Interface ProcessProcessorEnablerSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface ProcessProcessorEnablerSearch
extends OsidSearch

The search interface for governing process processor enabler searches.

Method Summary

Modifier and Type	Method	Description
ProcessProcessorEnablerSearchRecord	getProcessProcessorEnablerSearchRecord(Type processProcessorEnablerSearchRecordType)	Gets the process processor enabler search record corresponding to the given process processor enabler search record Type.
void	orderProcessProcessorEnablerResults(ProcessProcessorEnablerSearchOrder processProcessorEnablerSearchOrder)	Specify an ordering to the search results.
void	searchAmongProcessProcessorEnablers(IdList processProcessorEnablerIds)	Execute this search among the given list of process 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

searchAmongProcessProcessorEnablers

void searchAmongProcessProcessorEnablers(IdList processProcessorEnablerIds)

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

Parameters:

processProcessorEnablerIds - list of process processor enablers

Throws:

NullArgumentException - processProcessorEnablerIds is null

Compliance:

mandatory - This method must be implemented.

orderProcessProcessorEnablerResults

void orderProcessProcessorEnablerResults(ProcessProcessorEnablerSearchOrder processProcessorEnablerSearchOrder)

Specify an ordering to the search results.

Parameters:

processProcessorEnablerSearchOrder - process processor enabler search order

Throws:

NullArgumentException - processProcessorEnablerSearchOrder is null

UnsupportedException - processProcessorEnablerSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getProcessProcessorEnablerSearchRecord

ProcessProcessorEnablerSearchRecord getProcessProcessorEnablerSearchRecord(Type processProcessorEnablerSearchRecordType)
                                                                    throws OperationFailedException

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

Parameters:

processProcessorEnablerSearchRecordType - a process processor enabler search record type

Returns:

the process processor enabler search record

Throws:

NullArgumentException - processProcessorEnablerSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(processProcessorEnablerSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.