Interface ProcessEnablerSearchSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession, ProcessEnablerQuerySession

public interface ProcessEnablerSearchSession
extends ProcessEnablerQuerySession

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

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

This session defines views that offer differing behaviors for searching.

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

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

Method Summary

Modifier and Type	Method	Description
ProcessEnablerQuery	getProcessEnablerQueryFromInspector(ProcessEnablerQueryInspector processEnablerQueryInspector)	Gets a process enabler query from an inspector.
ProcessEnablerSearchResults	getProcessEnablersBySearch(ProcessEnablerQuery processEnablerQuery, ProcessEnablerSearch processEnablerSearch)	Gets the search results matching the given search query using the given search.
ProcessEnablerSearch	getProcessEnablerSearch()	Gets a process enabler search.
ProcessEnablerSearchOrder	getProcessEnablerSearchOrder()	Gets a process 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 ProcessEnablerQuerySession

canSearchProcessEnablers, getOffice, getOfficeId, getProcessEnablerQuery, getProcessEnablersByQuery, useFederatedOfficeView, useIsolatedOfficeView

Modifier and Type	Method	Description
boolean	canSearchProcessEnablers()	Tests if this user can perform ProcessEnabler lookups.
Office	getOffice()	Gets the Office associated with this session.
Id	getOfficeId()	Gets the Office Id associated with this session.
ProcessEnablerQuery	getProcessEnablerQuery()	Gets a process enabler query.
ProcessEnablerList	getProcessEnablersByQuery(ProcessEnablerQuery processEnablerQuery)	Gets a list of ProcessEnablers matching the given process enabler query.
void	useFederatedOfficeView()	Federates the view for methods in this session.
void	useIsolatedOfficeView()	Isolates the view for methods in this session.

Method Details

getProcessEnablerSearch

ProcessEnablerSearch getProcessEnablerSearch()

Gets a process enabler search.

Returns:

the process enabler search

Compliance:

mandatory - This method must be implemented.

getProcessEnablerSearchOrder

ProcessEnablerSearchOrder getProcessEnablerSearchOrder()

Gets a process enabler search order. The ProcessEnablerSearchOrder is supplied to a ProcessEnablerSearch to specify the ordering of results.

Returns:

the process enabler search order

Compliance:

mandatory - This method must be implemented.

getProcessEnablersBySearch

ProcessEnablerSearchResults getProcessEnablersBySearch(ProcessEnablerQuery processEnablerQuery,
 ProcessEnablerSearch processEnablerSearch)
                                                throws OperationFailedException,
PermissionDeniedException

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

Parameters:

processEnablerQuery - the process enabler query

processEnablerSearch - the process enabler search

Returns:

the returned search results

Throws:

NullArgumentException - processEnablerQuery or processEnablerSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - processEnablerQuery or processEnablerSearch is not of this service

Compliance:

mandatory - This method must be implemented.

getProcessEnablerQueryFromInspector

ProcessEnablerQuery getProcessEnablerQueryFromInspector(ProcessEnablerQueryInspector processEnablerQueryInspector)

Gets a process enabler query from an inspector. The inspector is available from a ProcessEnablerSearchResults.

Parameters:

processEnablerQueryInspector - a process enabler query inspector

Returns:

the process enabler query

Throws:

NullArgumentException - processEnablerQueryInspector is null

UnsupportedException - processEnablerQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.