Interface JobProcessorEnablerSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface JobProcessorEnablerSearch
extends OsidSearch

The search interface for governing job processor enabler searches.

Method Summary

Modifier and Type	Method	Description
JobProcessorEnablerSearchRecord	getJobProcessorEnablerSearchRecord(Type jobProcessorEnablerSearchRecordType)	Gets the job processor enabler search record corresponding to the given job processor enabler search record Type.
void	orderJobProcessorEnablerResults(JobProcessorEnablerSearchOrder jobProcessorEnablerSearchOrder)	Specify an ordering to the search results.
void	searchAmongJobProcessorEnablers(IdList jobProcessorEnablerIds)	Execute this search among the given list of job 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

searchAmongJobProcessorEnablers

void searchAmongJobProcessorEnablers(IdList jobProcessorEnablerIds)

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

Parameters:

jobProcessorEnablerIds - list of job processor enablers

Throws:

NullArgumentException - jobProcessorEnablerIds is null

Compliance:

mandatory - This method must be implemented.

orderJobProcessorEnablerResults

void orderJobProcessorEnablerResults(JobProcessorEnablerSearchOrder jobProcessorEnablerSearchOrder)

Specify an ordering to the search results.

Parameters:

jobProcessorEnablerSearchOrder - job processor enabler search order

Throws:

NullArgumentException - jobProcessorEnablerSearchOrder is null

UnsupportedException - jobProcessorEnablerSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getJobProcessorEnablerSearchRecord

JobProcessorEnablerSearchRecord getJobProcessorEnablerSearchRecord(Type jobProcessorEnablerSearchRecordType)
                                                            throws OperationFailedException

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

Parameters:

jobProcessorEnablerSearchRecordType - a job processor enabler search record type

Returns:

the job processor enabler search record

Throws:

NullArgumentException - jobProcessorEnablerSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(jobProcessorEnablerSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.