org.osid.hold

Interface IssueQuerySession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidSession

All Known Subinterfaces:

IssueSearchSession

public interface IssueQuerySession
extends OsidSession

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

This session defines views that offer differing behaviors for searching.

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

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
boolean	canSearchIssues() Tests if this user can perform Issue lookups.
IssueQuery	getIssueQuery() Gets an issue query.
IssueList	getIssuesByQuery(IssueQuery issueQuery) Gets a list of Issues matching the given issue query.
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 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

getOublietteId

Id getOublietteId()

Gets the Oubliette Id associated with this session.

Returns:

the Oubliette Id associated with this session

Compliance:

mandatory - This method must be implemented.

getOubliette

Oubliette getOubliette()
                       throws OperationFailedException,
                              PermissionDeniedException

Gets the Oubliette associated with this session.

Returns:

the oubliette

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canSearchIssues

boolean canSearchIssues()

Tests if this user can perform Issue lookups. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a PERMISSION_DENIED. This is intended as a hint to an application that may not offer lookup operations to unauthorized users.

Returns:

false if search methods are not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

useFederatedOublietteView

void useFederatedOublietteView()

Federates the view for methods in this session. A federated view will include issues in oubliettes which are children of this oubliette in the oubliette hierarchy.

Compliance:

mandatory - This method is must be implemented.

useIsolatedOublietteView

void useIsolatedOublietteView()

Isolates the view for methods in this session. An isolated view restricts lookups to this oubliette only.

Compliance:

mandatory - This method is must be implemented.

getIssueQuery

IssueQuery getIssueQuery()

Gets an issue query.

Returns:

the issue query

Compliance:

mandatory - This method must be implemented.

getIssuesByQuery

IssueList getIssuesByQuery(IssueQuery issueQuery)
                           throws OperationFailedException,
                                  PermissionDeniedException

Gets a list of Issues matching the given issue query.

Parameters:

issueQuery - the issue query

Returns:

the returned IssueList

Throws:

NullArgumentException - issueQuery is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - issueQuery is not of this service

Compliance:

mandatory - This method must be implemented.