org.osid.workflow.rules

Interface ProcessEnablerSearchSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, 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

Methods

Modifier and Type	Method and 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 org.osid.workflow.rules.ProcessEnablerQuerySession

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

Methods inherited from interface org.osid.OsidSession

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

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

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.