org.osid.resourcing.rules

Interface JobProcessorSearchSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, JobProcessorQuerySession, 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

Methods

Modifier and Type	Method and 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 org.osid.resourcing.rules.JobProcessorQuerySession

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

Methods inherited from interface org.osid.OsidSession

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

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

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.