org.osid.tracking

Interface IssueSearchSession

All Superinterfaces:

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

Methods

Modifier and Type	Method and 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 org.osid.tracking.IssueQuerySession

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

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

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.