Interface JobSearchSession

All Superinterfaces:

AutoCloseable, Closeable, JobQuerySession, OsidSession, OsidSession

public interface JobSearchSession
extends JobQuerySession

This session provides methods for searching among Job objects. The search query is constructed using the JobQuery.

getJobsByQuery() is the basic search method and returns a list of Jobs. A more advanced search may be performed with getJobsBySearch(). It accepts a JobSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getJobsBySearch() returns a JobSearchResults that can be used to access the resulting JobList or be used to perform a search within the result set through JobSearch.

This session defines views that offer differing behaviors for searching.

• federated foundry view: searches include jobs in foundries of which this foundry is an ancestor in the foundry hierarchy
• isolated foundry view: searches are restricted to jobs in this foundry

Jobs may have a query record indicated by their respective record types. The query record is accessed via the JobQuery.

Method Summary

Modifier and Type	Method	Description
JobQuery	getJobQueryFromInspector(JobQueryInspector jobQueryInspector)	Gets a job query from an inspector.
JobSearchResults	getJobsBySearch(JobQuery jobQuery, JobSearch jobSearch)	Gets the search results matching the given search query using the given search.
JobSearch	getJobSearch()	Gets a job search.
JobSearchOrder	getJobSearchOrder()	Gets a job search order.

Methods inherited from interface Closeable

close

Methods inherited from interface JobQuerySession

canSearchJobs, getFoundry, getFoundryId, getJobQuery, getJobsByQuery, useFederatedFoundryView, useIsolatedFoundryView

Modifier and Type	Method	Description
boolean	canSearchJobs()	Tests if this user can perform Job lookups.
Foundry	getFoundry()	Gets the Foundry associated with this session.
Id	getFoundryId()	Gets the Foundry Id associated with this session.
JobQuery	getJobQuery()	Gets a job query.
JobList	getJobsByQuery(JobQuery jobQuery)	Gets a list of Jobs matching the given job query.
void	useFederatedFoundryView()	Federates the view for methods in this session.
void	useIsolatedFoundryView()	Isolates the view for methods in this session.

Methods inherited from interface OsidSession

close

Modifier and Type	Method	Description
void	close()	Close this session.

Methods inherited from interface OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Modifier and Type	Method	Description
Agent	getAuthenticatedAgent()	Gets the agent authenticated to this session.
Id	getAuthenticatedAgentId()	Gets the Id of the agent authenticated to this session.
BigDecimal	getClockRate()	Gets the rate of the service clock.
Date	getDate()	Gets the service date which may be the current date or the effective date in which this session exists.
Agent	getEffectiveAgent()	Gets the effective agent in use by this session.
Id	getEffectiveAgentId()	Gets the Id of the effective agent in use by this session.
Type	getFormatType()	Gets the DisplayText format Type preference in effect for this session.
Locale	getLocale()	Gets the locale indicating the localization preferences in effect for this session.
boolean	isAuthenticated()	Tests if an agent is authenticated to this session.
Transaction	startTransaction()	Starts a new transaction for this sesson.
boolean	supportsTransactions()	Tests for the availability of transactions.

Method Details

getJobSearch

JobSearch getJobSearch()

Gets a job search.

Returns:

the job search

Compliance:

mandatory - This method must be implemented.

getJobSearchOrder

JobSearchOrder getJobSearchOrder()

Gets a job search order. The JobSearchOrder is supplied to a JobSearch to specify the ordering of results.

Returns:

the job search order

Compliance:

mandatory - This method must be implemented.

getJobsBySearch

JobSearchResults getJobsBySearch(JobQuery jobQuery,
 JobSearch jobSearch)
                          throws OperationFailedException,
PermissionDeniedException

Gets the search results matching the given search query using the given search.

Parameters:

jobQuery - the job query

jobSearch - the job search

Returns:

the returned search results

Throws:

NullArgumentException - jobQuery or jobSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - jobQuery or jobSearch is not of this service

Compliance:

mandatory - This method must be implemented.

getJobQueryFromInspector

JobQuery getJobQueryFromInspector(JobQueryInspector jobQueryInspector)

Gets a job query from an inspector. The inspector is available from a JobSearchResults.

Parameters:

jobQueryInspector - a job query inspector

Returns:

the job query

Throws:

NullArgumentException - jobQueryInspector is null

UnsupportedException - jobQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.