Interface JobConstrainerSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface JobConstrainerSearch
extends OsidSearch

The search interface for governing job constrainer searches.

Method Summary

Modifier and Type	Method	Description
JobConstrainerSearchRecord	getJobConstrainerSearchRecord(Type jobConstrainerSearchRecordType)	Gets the job constrainer search record corresponding to the given job constrainer search record Type .This method is used to retrieve an object implementing the requested record.
void	orderJobConstrainerResults(JobConstrainerSearchOrder jobConstrainerSearchOrder)	Specify an ordering to the search results.
void	searchAmongJobConstrainers(IdList foundryIds)	Execute this search among the given list of job constrainers.

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

searchAmongJobConstrainers

void searchAmongJobConstrainers(IdList foundryIds)

Execute this search among the given list of job constrainers.

Parameters:

foundryIds - list of job constrainers

Throws:

NullArgumentException - foundryIds is null

Compliance:

mandatory - This method must be implemented.

orderJobConstrainerResults

void orderJobConstrainerResults(JobConstrainerSearchOrder jobConstrainerSearchOrder)

Specify an ordering to the search results.

Parameters:

jobConstrainerSearchOrder - job constrainer search order

Throws:

NullArgumentException - jobConstrainerSearchOrder is null

UnsupportedException - jobConstrainerSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getJobConstrainerSearchRecord

JobConstrainerSearchRecord getJobConstrainerSearchRecord(Type jobConstrainerSearchRecordType)
                                                  throws OperationFailedException

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

Parameters:

jobConstrainerSearchRecordType - a job constrainer search record type

Returns:

the job constrainer search record

Throws:

NullArgumentException - jobConstrainerSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(jobConstrainerSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.