Interface JobSearch

All Superinterfaces:

Extensible, OsidCondition, OsidSearch, Suppliable

public interface JobSearch
extends OsidSearch

The search interface for governing job searches.

Method Summary

Modifier and Type	Method	Description
JobSearchRecord	getJobSearchRecord(Type jobSearchRecordType)	Gets the job search record corresponding to the given job search record Type.
void	orderJobResults(JobSearchOrder jobSearchOrder)	Specify an ordering to the search results.
void	searchAmongJobs(IdList jobIds)	Execute this search among the given list of jobs.

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

searchAmongJobs

void searchAmongJobs(IdList jobIds)

Execute this search among the given list of jobs.

Parameters:

jobIds - list of jobs

Throws:

NullArgumentException - jobIds is null

Compliance:

mandatory - This method must be implemented.

orderJobResults

void orderJobResults(JobSearchOrder jobSearchOrder)

Specify an ordering to the search results.

Parameters:

jobSearchOrder - job search order

Throws:

NullArgumentException - jobSearchOrder is null

UnsupportedException - jobSearchOrder is not of this service

Compliance:

mandatory - This method must be implemented.

getJobSearchRecord

JobSearchRecord getJobSearchRecord(Type jobSearchRecordType)
                            throws OperationFailedException

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

Parameters:

jobSearchRecordType - a job search record type

Returns:

the job search record

Throws:

NullArgumentException - jobSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(jobSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.