Interface JobConstrainerEnablerSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface JobConstrainerEnablerSearch
extends OsidSearch

The search interface for governing job constrainer enabler searches.

Method Summary

Modifier and Type	Method	Description
JobConstrainerEnablerSearchRecord	getJobConstrainerEnablerSearchRecord(Type jobConstrainerEnablerSearchRecordType)	Gets the job constrainer enabler search record corresponding to the given job constrainer enabler search record Type.
void	orderJobConstrainerEnablerResults(JobConstrainerEnablerSearchOrder jobConstrainerEnablerSearchOrder)	Specify an ordering to the search results.
void	searchAmongJobConstrainerEnablers(IdList jobConstrainerEnablerIds)	Execute this search among the given list of job constrainer 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

searchAmongJobConstrainerEnablers

void searchAmongJobConstrainerEnablers(IdList jobConstrainerEnablerIds)

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

Parameters:

jobConstrainerEnablerIds - list of job constrainer enablers

Throws:

NullArgumentException - jobConstrainerEnablerIds is null

Compliance:

mandatory - This method must be implemented.

orderJobConstrainerEnablerResults

void orderJobConstrainerEnablerResults(JobConstrainerEnablerSearchOrder jobConstrainerEnablerSearchOrder)

Specify an ordering to the search results.

Parameters:

jobConstrainerEnablerSearchOrder - job constrainer enabler search order

Throws:

NullArgumentException - jobConstrainerEnablerSearchOrder is null

UnsupportedException - jobConstrainerEnablerSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getJobConstrainerEnablerSearchRecord

JobConstrainerEnablerSearchRecord getJobConstrainerEnablerSearchRecord(Type jobConstrainerEnablerSearchRecordType)
                                                                throws OperationFailedException

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

Parameters:

jobConstrainerEnablerSearchRecordType - a job constrainer enabler search record type

Returns:

the job constrainer enabler search record

Throws:

NullArgumentException - jobConstrainerEnablerSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(jobConstrainerEnablerSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.