org.osid.resourcing.rules

Interface JobProcessorEnablerSearchSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, JobProcessorEnablerQuerySession, OsidSession

public interface JobProcessorEnablerSearchSession
extends JobProcessorEnablerQuerySession

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

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

This session defines views that offer differing behaviors for searching.

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

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

Method Summary

Methods

Modifier and Type	Method and Description
JobProcessorEnablerQuery	getJobProcessorEnablerQueryFromInspector(JobProcessorEnablerQueryInspector jobProcessorEnablerQueryInspector) Gets a job processor enabler query from an inspector.
JobProcessorEnablerSearchResults	getJobProcessorEnablersBySearch(JobProcessorEnablerQuery jobProcessorEnablerQuery, JobProcessorEnablerSearch jobProcessorEnablerSearch) Gets the search results matching the given search query using the given search.
JobProcessorEnablerSearch	getJobProcessorEnablerSearch() Gets a job processor enabler search.
JobProcessorEnablerSearchOrder	getJobProcessorEnablerSearchOrder() Gets a job processor enabler search order.

Methods inherited from interface org.osid.resourcing.rules.JobProcessorEnablerQuerySession

canSearchJobProcessorEnablers, getFoundry, getFoundryId, getJobProcessorEnablerQuery, getJobProcessorEnablersByQuery, 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

getJobProcessorEnablerSearch

JobProcessorEnablerSearch getJobProcessorEnablerSearch()

Gets a job processor enabler search.

Returns:

the job processor enabler search

Compliance:

mandatory - This method must be implemented.

getJobProcessorEnablerSearchOrder

JobProcessorEnablerSearchOrder getJobProcessorEnablerSearchOrder()

Gets a job processor enabler search order. The JobProcessorEnablerSearchOrder is supplied to a JobProcessorEnablerSearch to specify the ordering of results.

Returns:

the job processor enabler search order

Compliance:

mandatory - This method must be implemented.

getJobProcessorEnablersBySearch

JobProcessorEnablerSearchResults getJobProcessorEnablersBySearch(JobProcessorEnablerQuery jobProcessorEnablerQuery,
                                                               JobProcessorEnablerSearch jobProcessorEnablerSearch)
                                                                 throws OperationFailedException,
                                                                        PermissionDeniedException

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

Parameters:

jobProcessorEnablerQuery - the job processor enabler query

jobProcessorEnablerSearch - the job processor enabler search

Returns:

the returned search results

Throws:

NullArgumentException - jobProcessorEnablerQuery or jobProcessorEnablerSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - jobProcessorEnablerQuery or jobProcessorEnablerSearch is not of this service

Compliance:

mandatory - This method must be implemented.

getJobProcessorEnablerQueryFromInspector

JobProcessorEnablerQuery getJobProcessorEnablerQueryFromInspector(JobProcessorEnablerQueryInspector jobProcessorEnablerQueryInspector)

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

Parameters:

jobProcessorEnablerQueryInspector - a job processor enabler query inspector

Returns:

the job processor enabler query

Throws:

NullArgumentException - jobProcessorEnablerQueryInspector is null

UnsupportedException - jobProcessorEnablerQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.