org.osid.workflow

Interface StepSearchSession

All Superinterfaces:

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

public interface StepSearchSession
extends StepQuerySession

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

getStepsByQuery() is the basic search method and returns a list of Steps. A more advanced search may be performed with getStepsBySearch(). It accepts a StepSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getStepsBySearch() returns a StepSearchResults that can be used to access the resulting StepList or be used to perform a search within the result set through StepSearch.

This session defines views that offer differing behaviors for searching.

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

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

Method Summary

Methods

Modifier and Type	Method and Description
StepQuery	getStepQueryFromInspector(StepQueryInspector stepQueryInspector) Gets a step query from an inspector.
StepSearchResults	getStepsBySearch(StepQuery stepQuery, StepSearch stepSearch) Gets the search results matching the given search query using the given search.
StepSearch	getStepSearch() Gets a step search.
StepSearchOrder	getStepSearchOrder() Gets a step search order.

Methods inherited from interface org.osid.workflow.StepQuerySession

canSearchSteps, getOffice, getOfficeId, getStepQuery, getStepsByQuery, 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

getStepSearch

StepSearch getStepSearch()

Gets a step search.

Returns:

the step search

Compliance:

mandatory - This method must be implemented.

getStepSearchOrder

StepSearchOrder getStepSearchOrder()

Gets a step search order. The StepSearchOrder is supplied to a StepSearch to specify the ordering of results.

Returns:

the step search order

Compliance:

mandatory - This method must be implemented.

getStepsBySearch

StepSearchResults getStepsBySearch(StepQuery stepQuery,
                                 StepSearch stepSearch)
                                   throws OperationFailedException,
                                          PermissionDeniedException

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

Parameters:

stepQuery - the step query

stepSearch - the step search

Returns:

the step search results

Throws:

NullArgumentException - stepQuery or stepSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - stepQuery or stepSearch is not of this service

Compliance:

mandatory - This method must be implemented.

getStepQueryFromInspector

StepQuery getStepQueryFromInspector(StepQueryInspector stepQueryInspector)

Gets a step query from an inspector. The inspector is available from a StepSearchResults.

Parameters:

stepQueryInspector - a step query inspector

Returns:

the step query

Throws:

NullArgumentException - stepQueryInspector is null

UnsupportedException - stepQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.