org.osid.resourcing.rules

Interface JobConstrainerEnablerSearchSession

All Superinterfaces:

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

public interface JobConstrainerEnablerSearchSession
extends JobConstrainerEnablerQuerySession

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

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

This session defines views that offer differing behaviors for searching.

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

JobConstrainerEnablers may have a job constrainer enabler query record indicated by their respective record types. The job constrainer enabler query record is accessed via the JobConstrainerEnablerQuery.

Method Summary

Methods

Modifier and Type	Method and Description
JobConstrainerEnablerQuery	getJobConstrainerEnablerQueryFromInspector(JobConstrainerEnablerQueryInspector jobConstrainerEnablerQueryInspector) Gets a job constrainer enabler query from an inspector.
JobConstrainerEnablerSearchResults	getJobConstrainerEnablersBySearch(JobConstrainerEnablerQuery jobConstrainerEnablerQuery, JobConstrainerEnablerSearch jobConstrainerEnablerSearch) Gets the search results matching the given search query using the given search.
JobConstrainerEnablerSearch	getJobConstrainerEnablerSearch() Gets a job constrainer enabler search.
JobConstrainerEnablerSearchOrder	getJobConstrainerEnablerSearchOrder() Gets a job constrainer enabler search order.

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

canSearchJobConstrainerEnablers, getFoundry, getFoundryId, getJobConstrainerEnablerQuery, getJobConstrainerEnablersByQuery, 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

getJobConstrainerEnablerSearch

JobConstrainerEnablerSearch getJobConstrainerEnablerSearch()

Gets a job constrainer enabler search.

Returns:

the job constrainer enabler search

Compliance:

mandatory - This method must be implemented.

getJobConstrainerEnablerSearchOrder

JobConstrainerEnablerSearchOrder getJobConstrainerEnablerSearchOrder()

Gets a job constrainer enabler search order. The JobConstrainerEnablerSearchOrder is supplied to a JobConstrainerEnablerSearch to specify the ordering of results.

Returns:

the job constrainer enabler search order

Compliance:

mandatory - This method must be implemented.

getJobConstrainerEnablersBySearch

JobConstrainerEnablerSearchResults getJobConstrainerEnablersBySearch(JobConstrainerEnablerQuery jobConstrainerEnablerQuery,
                                                                   JobConstrainerEnablerSearch jobConstrainerEnablerSearch)
                                                                     throws OperationFailedException,
                                                                            PermissionDeniedException

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

Parameters:

jobConstrainerEnablerQuery - the job constrainer enabler query

jobConstrainerEnablerSearch - the job constrainer enabler search

Returns:

the returned search results

Throws:

NullArgumentException - jobConstrainerEnablerQuery or jobConstrainerEnablerSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - jobConstrainerEnablerQuery or jobConstrainerEnablerSearch is not of this service

Compliance:

mandatory - This method must be implemented.

getJobConstrainerEnablerQueryFromInspector

JobConstrainerEnablerQuery getJobConstrainerEnablerQueryFromInspector(JobConstrainerEnablerQueryInspector jobConstrainerEnablerQueryInspector)

Gets a job constrainer enabler query from an inspector. The inspector is available from a JobConstrainerEnablerSearchResults.

Parameters:

jobConstrainerEnablerQueryInspector - a job constrainer enabler query inspector

Returns:

the job constrainer enabler query

Throws:

NullArgumentException - jobConstrainerEnablerQueryInspector is null

UnsupportedException - jobConstrainerEnablerQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.