Interface JobSearchResults

All Superinterfaces:

Browsable, Extensible, OsidResult, OsidSearchResults

public interface JobSearchResults
extends OsidSearchResults

This interface provides a means to capture results of a search.

Method Summary

Modifier and Type	Method	Description
JobQueryInspector	getJobQueryInspector()	Gets the inspector for the query to examine the terms used in the search.
JobList	getJobs()	Gets the job list resulting from a search.
JobSearchResultsRecord	getJobSearchResultsRecord(Type jobSearchRecordType)	Gets the job search results record corresponding to the given job search record Type.

Methods inherited from interface Browsable

getProperties, getPropertiesByRecordType

Modifier and Type	Method	Description
PropertyList	getProperties()	Gets a list of properties.
PropertyList	getPropertiesByRecordType(Type recordType)	Gets a list of properties corresponding to the specified record type.

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 OsidSearchResults

getResultSize

Modifier and Type	Method	Description
long	getResultSize()	Returns the size of a result set from a search query.

Method Details

getJobs

JobList getJobs()

Gets the job list resulting from a search.

Returns:

the job list

Throws:

IllegalStateException - list already retrieved

Compliance:

mandatory - This method must be implemented.

getJobQueryInspector

JobQueryInspector getJobQueryInspector()

Gets the inspector for the query to examine the terms used in the search.

Returns:

the job query inspector

Compliance:

mandatory - This method must be implemented.

getJobSearchResultsRecord

JobSearchResultsRecord getJobSearchResultsRecord(Type jobSearchRecordType)
                                          throws OperationFailedException

Gets the job search results 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 results record

Throws:

NullArgumentException - jobSearchRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(jobSearchRecordType) is false

Compliance:

mandatory - This method must be implemented.