Interface StepSearchSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession, StepQuerySession

public interface StepSearchSession
extends StepQuerySession

This session provides methods for searching among Steps . 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

Modifier and Type	Method	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 Closeable

close

Methods inherited from interface OsidSession

close

Modifier and Type	Method	Description
void	close()	Close this session.

Methods inherited from interface OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Modifier and Type	Method	Description
Agent	getAuthenticatedAgent()	Gets the agent authenticated to this session.
Id	getAuthenticatedAgentId()	Gets the Id of the agent authenticated to this session.
BigDecimal	getClockRate()	Gets the rate of the service clock.
Date	getDate()	Gets the service date which may be the current date or the effective date in which this session exists.
Agent	getEffectiveAgent()	Gets the effective agent in use by this session.
Id	getEffectiveAgentId()	Gets the Id of the effective agent in use by this session.
Type	getFormatType()	Gets the DisplayText format Type preference in effect for this session.
Locale	getLocale()	Gets the locale indicating the localization preferences in effect for this session.
boolean	isAuthenticated()	Tests if an agent is authenticated to this session.
Transaction	startTransaction()	Starts a new transaction for this sesson.
boolean	supportsTransactions()	Tests for the availability of transactions.

Methods inherited from interface StepQuerySession

canSearchSteps, getOffice, getOfficeId, getStepQuery, getStepsByQuery, useFederatedOfficeView, useIsolatedOfficeView

Modifier and Type	Method	Description
boolean	canSearchSteps()	Tests if this user can perform Step lookups.
Office	getOffice()	Gets the Office associated with this session.
Id	getOfficeId()	Gets the Office Id associated with this session.
StepQuery	getStepQuery()	Gets a step query.
StepList	getStepsByQuery(StepQuery stepQuery)	Gets a list of Steps matching the given step query.
void	useFederatedOfficeView()	Federates the view for methods in this session.
void	useIsolatedOfficeView()	Isolates the view for methods in this session.

Method Details

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.