org.osid.workflow.rules

Interface StepConstrainerSearchSession

All Superinterfaces:

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

public interface StepConstrainerSearchSession
extends StepConstrainerQuerySession

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

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

This session defines views that offer differing behaviors for searching.

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

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

Method Summary

Methods

Modifier and Type	Method and Description
StepConstrainerQuery	getStepConstrainerQueryFromInspector(StepConstrainerQueryInspector stepConstrainerQueryInspector) Gets a step constrainer query from an inspector.
StepConstrainerSearchResults	getStepConstrainersBySearch(StepConstrainerQuery stepConstrainerQuery, StepConstrainerSearch stepConstrainerSearch) Gets the search results matching the given search query using the given search.
StepConstrainerSearch	getStepConstrainerSearch() Gets a step constrainer search.
StepConstrainerSearchOrder	getStepConstrainerSearchOrder() Gets a step constrainer search order.

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

canSearchStepConstrainers, getOffice, getOfficeId, getStepConstrainerQuery, getStepConstrainersByQuery, 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

getStepConstrainerSearch

StepConstrainerSearch getStepConstrainerSearch()

Gets a step constrainer search.

Returns:

the step constrainer search

Compliance:

mandatory - This method must be implemented.

getStepConstrainerSearchOrder

StepConstrainerSearchOrder getStepConstrainerSearchOrder()

Gets a step constrainer search order. The StepConstrainerSearchOrder is supplied to a StepConstrainerSearch to specify the ordering of results.

Returns:

the step constrainer search order

Compliance:

mandatory - This method must be implemented.

getStepConstrainersBySearch

StepConstrainerSearchResults getStepConstrainersBySearch(StepConstrainerQuery stepConstrainerQuery,
                                                       StepConstrainerSearch stepConstrainerSearch)
                                                         throws OperationFailedException,
                                                                PermissionDeniedException

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

Parameters:

stepConstrainerQuery - the step constrainer query

stepConstrainerSearch - the step constrainer search

Returns:

the returned search results

Throws:

NullArgumentException - stepConstrainerQuery or stepConstrainerSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - stepConstrainerQuery or stepConstrainerSearch is not of this service

Compliance:

mandatory - This method must be implemented.

getStepConstrainerQueryFromInspector

StepConstrainerQuery getStepConstrainerQueryFromInspector(StepConstrainerQueryInspector stepConstrainerQueryInspector)

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

Parameters:

stepConstrainerQueryInspector - a step constrainer query inspector

Returns:

the step constrainer query

Throws:

NullArgumentException - stepConstrainerQueryInspector is null

UnsupportedException - stepConstrainerQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.