Interface IssueEnablerSearchSession

All Superinterfaces:

AutoCloseable, Closeable, IssueEnablerQuerySession, OsidSession, OsidSession

public interface IssueEnablerSearchSession
extends IssueEnablerQuerySession

This session provides methods for searching among IssueEnablers . The search query is constructed using the IssueEnablerQuery .

getIssueEnablersByQuery() is the basic search method and returns a list of IssueEnablers . A more advanced search may be performed with getIssueEnablersBySearch() .It accepts an IssueEnablerSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as ordering. getIssueEnablersBySearch() returns an IssueEnablerSearchResults that can be used to access the resulting IssueEnablerList or be used to perform a search within the result set through IssueEnablerSearch .

This session defines views that offer differing behaviors for searching.

• federated oubliette view: searches include issue enablers in oubliettes of which this oubliette is an ancestor in the oubliette hierarchy
• isolated oubliette view: searches are restricted to issue enablers in this oubliette

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

Method Summary

Modifier and Type	Method	Description
IssueEnablerSearchResults	getIssueEnablerBySearch(IssueEnablerQuery issueEnablerQuery, IssueEnablerSearch issueEnablerSearch)	Gets the search results matching the given search query using the given search.
IssueEnablerQuery	getIssueEnablerQueryFromInspector(IssueEnablerQueryInspector issueEnablerQueryInspector)	Gets an issue enabler query from an inspector.
IssueEnablerSearch	getIssueEnablerSearch()	Gets an issue enabler search.
IssueEnablerSearchOrder	getIssueEnablerSearchOrder()	Gets an issue enabler search order.

Methods inherited from interface Closeable

close

Methods inherited from interface IssueEnablerQuerySession

canSearchIssueEnablers, getIssueEnablerQuery, getIssueEnablersByQuery, getOubliette, getOublietteId, useFederatedOublietteView, useIsolatedOublietteView

Modifier and Type	Method	Description
boolean	canSearchIssueEnablers()	Tests if this user can perform IssueEnabler lookups.
IssueEnablerQuery	getIssueEnablerQuery()	Gets an issue enabler query.
IssueEnablerList	getIssueEnablersByQuery(IssueEnablerQuery issueEnablerQuery)	Gets a list of IssueEnablers matching the given search.
Oubliette	getOubliette()	Gets the Oubliette associated with this session.
Id	getOublietteId()	Gets the Oubliette Id associated with this session.
void	useFederatedOublietteView()	Federates the view for methods in this session.
void	useIsolatedOublietteView()	Isolates the view for methods in this session.

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.

Method Details

getIssueEnablerSearch

IssueEnablerSearch getIssueEnablerSearch()

Gets an issue enabler search.

Returns:

the issue enabler search

Compliance:

mandatory - This method must be implemented.

getIssueEnablerSearchOrder

IssueEnablerSearchOrder getIssueEnablerSearchOrder()

Gets an issue enabler search order. The IssueEnablerSearchOrder is supplied to an IssueEnablerSearch to specify the ordering of results.

Returns:

the issue enabler search order

Compliance:

mandatory - This method must be implemented.

getIssueEnablerBySearch

IssueEnablerSearchResults getIssueEnablerBySearch(IssueEnablerQuery issueEnablerQuery,
 IssueEnablerSearch issueEnablerSearch)
                                           throws OperationFailedException,
PermissionDeniedException

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

Parameters:

issueEnablerQuery - the issue enabler query

issueEnablerSearch - the issue enabler search

Returns:

the returned search results

Throws:

NullArgumentException - issueEnablerQuery or issueEnablerSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - issueEnablerQuery or issueEnablerSearch is not of this service

Compliance:

mandatory - This method must be implemented.

getIssueEnablerQueryFromInspector

IssueEnablerQuery getIssueEnablerQueryFromInspector(IssueEnablerQueryInspector issueEnablerQueryInspector)

Gets an issue enabler query from an inspector. The inspector is available from an IssueEnablerSearchResults .

Parameters:

issueEnablerQueryInspector - an issue enabler query inspector

Returns:

the issue enabler query

Throws:

NullArgumentException - issueEnablerQueryInspector is null

UnsupportedException - issueEnablerQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.