Interface StepProcessorSearchSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession, StepProcessorQuerySession

public interface StepProcessorSearchSession
extends StepProcessorQuerySession

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

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

This session defines views that offer differing behaviors for searching.

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

StepProcessors may have a query record indicated by their respective record types. Thequery record is accessed via the StepProcessorQuery.

Method Summary

Modifier and Type	Method	Description
StepProcessorQuery	getStepProcessorQueryFromInspector(StepProcessorQueryInspector stepProcessorQueryInspector)	Gets a step processor query from an inspector.
StepProcessorSearchResults	getStepProcessorsBySearch(StepProcessorQuery stepProcessorQuery, StepProcessorSearch stepProcessorSearch)	Gets the search results matching the given search query using the given search.
StepProcessorSearch	getStepProcessorSearch()	Gets a step processor search.
StepProcessorSearchOrder	getStepProcessorSearchOrder()	Gets a step processor 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 StepProcessorQuerySession

canSearchStepProcessors, getOffice, getOfficeId, getStepProcessorQuery, getStepProcessorsByQuery, useFederatedOfficeView, useIsolatedOfficeView

Modifier and Type	Method	Description
boolean	canSearchStepProcessors()	Tests if this user can perform StepProcessor lookups.
Office	getOffice()	Gets the Office associated with this session.
Id	getOfficeId()	Gets the Office Id associated with this session.
StepProcessorQuery	getStepProcessorQuery()	Gets a step processor query.
StepProcessorList	getStepProcessorsByQuery(StepProcessorQuery stepProcessorQuery)	Gets a list of StepProcessors matching the given step processor query.
void	useFederatedOfficeView()	Federates the view for methods in this session.
void	useIsolatedOfficeView()	Isolates the view for methods in this session.

Method Details

getStepProcessorSearch

StepProcessorSearch getStepProcessorSearch()

Gets a step processor search.

Returns:

the step processor search

Compliance:

mandatory - This method must be implemented.

getStepProcessorSearchOrder

StepProcessorSearchOrder getStepProcessorSearchOrder()

Gets a step processor search order. The StepProcessorSearchOrder is supplied to a StepProcessorSearch to specify the ordering of results.

Returns:

the step processor search order

Compliance:

mandatory - This method must be implemented.

getStepProcessorsBySearch

StepProcessorSearchResults getStepProcessorsBySearch(StepProcessorQuery stepProcessorQuery,
 StepProcessorSearch stepProcessorSearch)
                                              throws OperationFailedException,
PermissionDeniedException

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

Parameters:

stepProcessorQuery - the step processor query

stepProcessorSearch - the step processor search

Returns:

the returned search results

Throws:

NullArgumentException - stepProcessorQuery or stepProcessorSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - stepProcessorQuery or stepProcessorSearch is not of this service

Compliance:

mandatory - This method must be implemented.

getStepProcessorQueryFromInspector

StepProcessorQuery getStepProcessorQueryFromInspector(StepProcessorQueryInspector stepProcessorQueryInspector)

Gets a step processor query from an inspector. The inspector is available from a StepProcessorSearchResults.

Parameters:

stepProcessorQueryInspector - a step processor query inspector

Returns:

the step processor query

Throws:

NullArgumentException - stepProcessorQueryInspector is null

UnsupportedException - stepProcessorQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.