Interface JobProcessorSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface JobProcessorSearch
extends OsidSearch

The search interface for governing job processor searches.

Method Summary

Modifier and Type	Method	Description
JobProcessorSearchRecord	getJobProcessorSearchRecord(Type jobProcessorSearchRecordType)	Gets the job processor search record corresponding to the given job processor search record Type .This method is used to retrieve an object implementing the requested record.
void	orderJobProcessorResults(JobProcessorSearchOrder jobProcessorSearchOrder)	Specify an ordering to the search results.
void	searchAmongJobProcessors(IdList foundryIds)	Execute this search among the given list of job processors.

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

searchAmongJobProcessors

void searchAmongJobProcessors(IdList foundryIds)

Execute this search among the given list of job processors.

Parameters:

foundryIds - list of job processors

Throws:

NullArgumentException - foundryIds is null

Compliance:

mandatory - This method must be implemented.

orderJobProcessorResults

void orderJobProcessorResults(JobProcessorSearchOrder jobProcessorSearchOrder)

Specify an ordering to the search results.

Parameters:

jobProcessorSearchOrder - job processor search order

Throws:

NullArgumentException - jobProcessorSearchOrder is null

UnsupportedException - jobProcessorSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getJobProcessorSearchRecord

JobProcessorSearchRecord getJobProcessorSearchRecord(Type jobProcessorSearchRecordType)
                                              throws OperationFailedException

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

Parameters:

jobProcessorSearchRecordType - a job processor search record type

Returns:

the job processor search record

Throws:

NullArgumentException - jobProcessorSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(jobProcessorSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.