Interface ProcessSearchSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession, ProcessQuerySession

public interface ProcessSearchSession
extends ProcessQuerySession

This session provides methods for searching among Processes . The search query is constructed using the ProcessQuery .

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

This session defines views that offer differing behaviors for searching.

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

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

Method Summary

Modifier and Type	Method	Description
ProcessSearchResults	getProcessesBySearch(ProcessQuery processQuery, ProcessSearch processSearch)	Gets the search results matching the given search query using the given search.
ProcessQuery	getProcessQueryFromInspector(ProcessQueryInspector processQueryInspector)	Gets a process query from an inspector.
ProcessSearch	getProcessSearch()	Gets a process search.
ProcessSearchOrder	getProcessSearchOrder()	Gets a process 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 ProcessQuerySession

canSearchProcesses, getOffice, getOfficeId, getProcessesByQuery, getProcessQuery, useFederatedOfficeView, useIsolatedOfficeView

Modifier and Type	Method	Description
boolean	canSearchProcesses()	Tests if this user can perform Process lookups.
Office	getOffice()	Gets the Office associated with this session.
Id	getOfficeId()	Gets the Office Id associated with this session.
ProcessList	getProcessesByQuery(ProcessQuery processQuery)	Gets a list of Processes matching the given process query.
ProcessQuery	getProcessQuery()	Gets a process query.
void	useFederatedOfficeView()	Federates the view for methods in this session.
void	useIsolatedOfficeView()	Isolates the view for methods in this session.

Method Details

getProcessSearch

ProcessSearch getProcessSearch()

Gets a process search.

Returns:

the process search

Compliance:

mandatory - This method must be implemented.

getProcessSearchOrder

ProcessSearchOrder getProcessSearchOrder()

Gets a process search order. The ProcessSearchOrder is supplied to a ProcessSearch to specify the ordering of results.

Returns:

the process search order

Compliance:

mandatory - This method must be implemented.

getProcessesBySearch

ProcessSearchResults getProcessesBySearch(ProcessQuery processQuery,
 ProcessSearch processSearch)
                                   throws OperationFailedException,
PermissionDeniedException

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

Parameters:

processQuery - the process query

processSearch - the process search

Returns:

the process search results

Throws:

NullArgumentException - processQuery or processSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - processQuery or processSearch is not of this service

Compliance:

mandatory - This method must be implemented.

getProcessQueryFromInspector

ProcessQuery getProcessQueryFromInspector(ProcessQueryInspector processQueryInspector)

Gets a process query from an inspector. The inspector is available from a ProcessSearchResults .

Parameters:

processQueryInspector - a process query inspector

Returns:

the process query

Throws:

NullArgumentException - processQueryInspector is null

UnsupportedException - processQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.