org.osid.resourcing.rules

Interface JobConstrainerSearchSession

All Superinterfaces:

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

public interface JobConstrainerSearchSession
extends JobConstrainerQuerySession

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

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

This session defines views that offer differing behaviors for searching.

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

JobConstrainers may have a job constrainer query record indicated by their respective record types. The job constrainer query record is accessed via the JobConstrainerQuery.

Method Summary

Methods

Modifier and Type	Method and Description
JobConstrainerQuery	getJobConstrainerQueryFromInspector(JobConstrainerQueryInspector jobConstrainerQueryInspector) Gets a job constrainer query from an inspector.
JobConstrainerSearchResults	getJobConstrainersBySearch(JobConstrainerQuery jobConstrainerQuery, JobConstrainerSearch jobConstrainerSearch) Gets the search results matching the given search query using the given search.
JobConstrainerSearch	getJobConstrainerSearch() Gets a job constrainer search.
JobConstrainerSearchOrder	getJobConstrainerSearchOrder() Gets a job constrainer search order.

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

canSearchJobConstrainers, getFoundry, getFoundryId, getJobConstrainerQuery, getJobConstrainersByQuery, 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

getJobConstrainerSearch

JobConstrainerSearch getJobConstrainerSearch()

Gets a job constrainer search.

Returns:

the job constrainer search

Compliance:

mandatory - This method must be implemented.

getJobConstrainerSearchOrder

JobConstrainerSearchOrder getJobConstrainerSearchOrder()

Gets a job constrainer search order. The JobConstrainerSearchOrder is supplied to a JobConstrainerSearch to specify the ordering of results.

Returns:

the job constrainer search order

Compliance:

mandatory - This method must be implemented.

getJobConstrainersBySearch

JobConstrainerSearchResults getJobConstrainersBySearch(JobConstrainerQuery jobConstrainerQuery,
                                                     JobConstrainerSearch jobConstrainerSearch)
                                                       throws OperationFailedException,
                                                              PermissionDeniedException

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

Parameters:

jobConstrainerQuery - the job constrainer query

jobConstrainerSearch - the job constrainer search

Returns:

the returned search results

Throws:

NullArgumentException - jobConstrainerQuery or jobConstrainerSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - jobConstrainerQuery or jobConstrainerSearch is not of this service

Compliance:

mandatory - This method must be implemented.

getJobConstrainerQueryFromInspector

JobConstrainerQuery getJobConstrainerQueryFromInspector(JobConstrainerQueryInspector jobConstrainerQueryInspector)

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

Parameters:

jobConstrainerQueryInspector - a job constrainer query inspector

Returns:

the job constrainer query

Throws:

NullArgumentException - jobConstrainerQueryInspector is null

UnsupportedException - jobConstrainerQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.