org.osid.workflow.rules

Interface StepConstrainerEnablerSearchSession

All Superinterfaces:

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

public interface StepConstrainerEnablerSearchSession
extends StepConstrainerEnablerQuerySession

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

getStepConstrainerEnablersByQuery() is the basic search method and returns a list of StepConstrainerEnablers. A more advanced search may be performed with getStepConstrainerEnablersBySearch(). It accepts a StepConstrainerEnablerSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as workflow. getStepConstrainerEnablersBySearch() returns a StepConstrainerEnablerSearchResults that can be used to access the resulting StepConstrainerEnablerList or be used to perform a search within the result set through StepConstrainerEnablerSearch.

This session defines views that offer differing behaviors for searching.

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

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

Method Summary

Methods

Modifier and Type	Method and Description
StepConstrainerEnablerQuery	getStepConstrainerEnablerQueryFromInspector(StepConstrainerEnablerQueryInspector stepConstrainerEnablerQueryInspector) Gets a step constrainer enabler query from an inspector.
StepConstrainerEnablerSearchResults	getStepConstrainerEnablersBySearch(StepConstrainerEnablerQuery stepConstrainerEnablerQuery, StepConstrainerEnablerSearch stepConstrainerEnablerSearch) Gets the search results matching the given search query using the given search.
StepConstrainerEnablerSearch	getStepConstrainerEnablerSearch() Gets a step constrainer enabler search.
StepConstrainerEnablerSearchOrder	getStepConstrainerEnablerSearchOrder() Gets a step constrainer enabler search order.

Methods inherited from interface org.osid.workflow.rules.StepConstrainerEnablerQuerySession

canSearchStepConstrainerEnablers, getOffice, getOfficeId, getStepConstrainerEnablerQuery, getStepConstrainerEnablersByQuery, useFederatedOfficeView, useIsolatedOfficeView

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

getStepConstrainerEnablerSearch

StepConstrainerEnablerSearch getStepConstrainerEnablerSearch()

Gets a step constrainer enabler search.

Returns:

the step constrainer enabler search

Compliance:

mandatory - This method must be implemented.

getStepConstrainerEnablerSearchOrder

StepConstrainerEnablerSearchOrder getStepConstrainerEnablerSearchOrder()

Gets a step constrainer enabler search order. The StepConstrainerEnablerSearchOrder is supplied to a StepConstrainerEnablerSearch to specify the ordering of results.

Returns:

the step constrainer enabler search order

Compliance:

mandatory - This method must be implemented.

getStepConstrainerEnablersBySearch

StepConstrainerEnablerSearchResults getStepConstrainerEnablersBySearch(StepConstrainerEnablerQuery stepConstrainerEnablerQuery,
                                                                     StepConstrainerEnablerSearch stepConstrainerEnablerSearch)
                                                                       throws OperationFailedException,
                                                                              PermissionDeniedException

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

Parameters:

stepConstrainerEnablerQuery - the step constrainer enabler query

stepConstrainerEnablerSearch - the step constrainer enabler search

Returns:

the returned search results

Throws:

NullArgumentException - stepConstrainerEnablerQuery or stepConstrainerEnablerSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - stepConstrainerEnablerQuery or stepConstrainerEnablerSearch is not of this service

Compliance:

mandatory - This method must be implemented.

getStepConstrainerEnablerQueryFromInspector

StepConstrainerEnablerQuery getStepConstrainerEnablerQueryFromInspector(StepConstrainerEnablerQueryInspector stepConstrainerEnablerQueryInspector)

Gets a step constrainer enabler query from an inspector. The inspector is available from a StepConstrainerEnablerSearchResults.

Parameters:

stepConstrainerEnablerQueryInspector - a step constrainer enabler query inspector

Returns:

the step constrainer enabler query

Throws:

NullArgumentException - stepConstrainerEnablerQueryInspector is null

UnsupportedException - stepConstrainerEnablerQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.