Interface JobProcessorSearchSession

All Superinterfaces:

AutoCloseable, Closeable, JobProcessorQuerySession, OsidSession, OsidSession

public interface JobProcessorSearchSession
extends JobProcessorQuerySession

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

getJobProcessorsByQuery() is the basic search method and returns a list of JobProcessors . A more advanced search may be performed with getJobProcessorsBySearch() .It accepts a JobProcessorSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as resourcing. getJobProcessorsBySearch() returns a JobProcessorSearchResults that can be used to access the resulting JobProcessorList or be used to perform a search within the result set through JobProcessorSearch .

This session defines views that offer differing behaviors for searching.

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

JobProcessors may have a job processor query record indicated by their respective record types. The job processor query record is accessed via the JobProcessorQuery .

Method Summary

Modifier and Type	Method	Description
JobProcessorQuery	getJobProcessorQueryFromInspector(JobProcessorQueryInspector jobProcessorQueryInspector)	Gets a job processor query from an inspector.
JobProcessorSearchResults	getJobProcessorsBySearch(JobProcessorQuery jobProcessorQuery, JobProcessorSearch jobProcessorSearch)	Gets the search results matching the given search query using the given search.
JobProcessorSearch	getJobProcessorSearch()	Gets a job processor search.
JobProcessorSearchOrder	getJobProcessorSearchOrder()	Gets a job processor search order.

Methods inherited from interface Closeable

close

Methods inherited from interface JobProcessorQuerySession

canSearchJobProcessors, getFoundry, getFoundryId, getJobProcessorQuery, getJobProcessorsByQuery, useFederatedFoundryView, useIsolatedFoundryView

Modifier and Type	Method	Description
boolean	canSearchJobProcessors()	Tests if this user can perform JobProcessor lookups.
Foundry	getFoundry()	Gets the Foundry associated with this session.
Id	getFoundryId()	Gets the Foundry Id associated with this session.
JobProcessorQuery	getJobProcessorQuery()	Gets a job processor query.
JobProcessorList	getJobProcessorsByQuery(JobProcessorQuery jobProcessorQuery)	Gets a list of JobProcessors matching the given job processor 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

getJobProcessorSearch

JobProcessorSearch getJobProcessorSearch()

Gets a job processor search.

Returns:

the job processor search

Compliance:

mandatory - This method must be implemented.

getJobProcessorSearchOrder

JobProcessorSearchOrder getJobProcessorSearchOrder()

Gets a job processor search order. The JobProcessorSearchOrder is supplied to a JobProcessorSearch to specify the ordering of results.

Returns:

the job processor search order

Compliance:

mandatory - This method must be implemented.

getJobProcessorsBySearch

JobProcessorSearchResults getJobProcessorsBySearch(JobProcessorQuery jobProcessorQuery,
 JobProcessorSearch jobProcessorSearch)
                                            throws OperationFailedException,
PermissionDeniedException

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

Parameters:

jobProcessorQuery - the job processor query

jobProcessorSearch - the job processor search

Returns:

the returned search results

Throws:

NullArgumentException - jobProcessorQuery or jobProcessorSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - jobProcessorQuery or jobProcessorSearch is not of this service

Compliance:

mandatory - This method must be implemented.

getJobProcessorQueryFromInspector

JobProcessorQuery getJobProcessorQueryFromInspector(JobProcessorQueryInspector jobProcessorQueryInspector)

Gets a job processor query from an inspector. The inspector is available from a JobProcessorSearchResults .

Parameters:

jobProcessorQueryInspector - a job processor query inspector

Returns:

the job processor query

Throws:

NullArgumentException - jobProcessorQueryInspector is null

UnsupportedException - jobProcessorQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.