Interface StepEnablerSearchSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession, StepEnablerQuerySession

public interface StepEnablerSearchSession
extends StepEnablerQuerySession

This session provides methods for searching among StepEnablers . The search query is constructed using the StepEnablerQuery .

getStepEnablersByQuery() is the basic search method and returns a list of StepEnablers . A more advanced search may be performed with getStepEnablersBySearch() .It accepts a StepEnablerSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getStepEnablersBySearch() returns a StepEnablerSearchResults that can be used to access the resulting StepEnablerList or be used to perform a search within the result set through Ste pEnablerSearch .

This session defines views that offer differing behaviors for searching.

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

Step enablers may have a query record indicated by their respective record types. The query record is accessed via the StepEnablerQuery .

Method Summary

Modifier and Type	Method	Description
StepEnablerQuery	getStepEnablerQueryFromInspector(StepEnablerQueryInspector stepEnablerQueryInspector)	Gets a step enabler query from an inspector.
StepEnablerSearchResults	getStepEnablersBySearch(StepEnablerQuery stepEnablerQuery, StepEnablerSearch stepEnablerSearch)	Gets the search results matching the given search query using the given search.
StepEnablerSearch	getStepEnablerSearch()	Gets a step enabler search.
StepEnablerSearchOrder	getStepEnablerSearchOrder()	Gets a step enabler 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 StepEnablerQuerySession

canSearchStepEnablers, getOffice, getOfficeId, getStepEnablerQuery, getStepEnablersByQuery, useFederatedOfficeView, useIsolatedOfficeView

Modifier and Type	Method	Description
boolean	canSearchStepEnablers()	Tests if this user can perform StepEnabler searches.
Office	getOffice()	Gets the Office associated with this session.
Id	getOfficeId()	Gets the Office Id associated with this session.
StepEnablerQuery	getStepEnablerQuery()	Gets a step enabler query.
StepEnablerList	getStepEnablersByQuery(StepEnablerQuery stepEnablerQuery)	Gets a list of StepEnablers matching the given search.
void	useFederatedOfficeView()	Federates the view for methods in this session.
void	useIsolatedOfficeView()	Isolates the view for methods in this session.

Method Details

getStepEnablerSearch

StepEnablerSearch getStepEnablerSearch()

Gets a step enabler search.

Returns:

the step enabler search

Compliance:

mandatory - This method must be implemented.

getStepEnablerSearchOrder

StepEnablerSearchOrder getStepEnablerSearchOrder()

Gets a step enabler search order. The StepEnablerSearchOrder is supplied to a StepEnablerSearch to specify the ordering of results.

Returns:

the step enabler search order

Compliance:

mandatory - This method must be implemented.

getStepEnablersBySearch

StepEnablerSearchResults getStepEnablersBySearch(StepEnablerQuery stepEnablerQuery,
 StepEnablerSearch stepEnablerSearch)
                                          throws OperationFailedException,
PermissionDeniedException

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

Parameters:

stepEnablerQuery - the step enabler query

stepEnablerSearch - the step enabler search

Returns:

the returned search results

Throws:

NullArgumentException - stepEnablerQuery or stepEnablerSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - stepEnablerQuery or stepEnablerSearch is not of this service

Compliance:

mandatory - This method must be implemented.

getStepEnablerQueryFromInspector

StepEnablerQuery getStepEnablerQueryFromInspector(StepEnablerQueryInspector stepEnablerQueryInspector)

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

Parameters:

stepEnablerQueryInspector - a step enabler query inspector

Returns:

the step enabler query

Throws:

NullArgumentException - stepEnablerQueryInspector is null

UnsupportedException - stepEnablerQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.