Interface IssueSearchSession

All Superinterfaces:

AutoCloseable, Closeable, IssueQuerySession, OsidSession, OsidSession

public interface IssueSearchSession
extends IssueQuerySession

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

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

This session defines views that offer differing behaviors for searching.

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

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

Method Summary

Modifier and Type	Method	Description
IssueQuery	getIssueQueryFromInspector(IssueQueryInspector issueQueryInspector)	Gets an issue query from an inspector.
IssueSearchResults	getIssuesBySearch(IssueQuery issueQuery, IssueSearch issueSearch)	Gets the search results matching the given search query using the given search.
IssueSearch	getIssueSearch()	Gets an issue search.
IssueSearchOrder	getIssueSearchOrder()	Gets an issue search order.

Methods inherited from interface Closeable

close

Methods inherited from interface IssueQuerySession

canSearchIssues, getFrontOffice, getFrontOfficeId, getIssueQuery, getIssuesByQuery, useFederatedFrontOfficeView, useIsolatedFrontOfficeView

Modifier and Type	Method	Description
boolean	canSearchIssues()	Tests if this user can perform Issue lookups.
FrontOffice	getFrontOffice()	Gets the FrontOffice associated with this session.
Id	getFrontOfficeId()	Gets the FrontOffice Id associated with this session.
IssueQuery	getIssueQuery()	Gets an issue query.
IssueList	getIssuesByQuery(IssueQuery issueQuery)	Gets a list of Issues matching the given issue query.
void	useFederatedFrontOfficeView()	Federates the view for methods in this session.
void	useIsolatedFrontOfficeView()	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

getIssueSearch

IssueSearch getIssueSearch()

Gets an issue search.

Returns:

the issue search

Compliance:

mandatory - This method must be implemented.

getIssueSearchOrder

IssueSearchOrder getIssueSearchOrder()

Gets an issue search order. The IssueSearchOrder is supplied to an IssueSearch to specify the ordering of results.

Returns:

the issue search order

Compliance:

mandatory - This method must be implemented.

getIssuesBySearch

IssueSearchResults getIssuesBySearch(IssueQuery issueQuery,
 IssueSearch issueSearch)
                              throws OperationFailedException,
PermissionDeniedException

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

Parameters:

issueQuery - the issue query

issueSearch - the issue search

Returns:

the issue search results

Throws:

NullArgumentException - issueQuery or issueSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - issueQuery or issueSearch is not of this service

Compliance:

mandatory - This method must be implemented.

getIssueQueryFromInspector

IssueQuery getIssueQueryFromInspector(IssueQueryInspector issueQueryInspector)

Gets an issue query from an inspector. The inspector is available from a IssueSearchResults .

Parameters:

issueQueryInspector - an issue query inspector

Returns:

the issue query

Throws:

NullArgumentException - issueQueryInspector is null

UnsupportedException - issueQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.