Interface AuditSearchSession

All Superinterfaces:

AuditQuerySession, AutoCloseable, Closeable, OsidSession, OsidSession

public interface AuditSearchSession
extends AuditQuerySession

This session provides methods for searching among Audits . The search query is constructed using the AudityQuery .

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

This session defines views that offer differing behaviors for searching.

• federated action group view: searches include audits in action groups of which this action group is an ancestor in the action group hierarchy
• isolated action group view: searches are restricted to audits in this action group

Audits may have an audit record indicated by their respective record types. The audit record is accessed via the AuditQuery .

Method Summary

Modifier and Type	Method	Description
AuditQuery	getAuditQueryFromInspector(AuditQueryInspector auditQueryInspector)	Gets an audit query from an inspector.
AuditSearchResults	getAuditsBySearch(AuditQuery auditQuery, AuditSearch auditSearch)	Gets the search results matching the given search query using the given search.
AuditSearch	getAuditSearch()	Gets an audit search.
AuditSearchOrder	getAuditSearchOrder()	Gets an audit search order.

Methods inherited from interface AuditQuerySession

canSearchAudits, getAuditQuery, getAuditsByQuery, getInquest, getInquestId, useFederatedInquestView, useIsolatedInquestView

Modifier and Type	Method	Description
boolean	canSearchAudits()	Tests if this user can perform Audit lookups.
AuditQuery	getAuditQuery()	Gets an audit query.
AuditList	getAuditsByQuery(AuditQuery auditQuery)	Gets a list of Audits matching the given audit query.
Inquest	getInquest()	Gets the Inquest associated with this session.
Id	getInquestId()	Gets the Inquest Id associated with this session.
void	useFederatedInquestView()	Federates the view for methods in this session.
void	useIsolatedInquestView()	Isolates the view for methods in this session.

Methods inherited from interface Closeable

close

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

getAuditSearch

AuditSearch getAuditSearch()

Gets an audit search.

Returns:

the audit search

Compliance:

mandatory - This method must be implemented.

getAuditSearchOrder

AuditSearchOrder getAuditSearchOrder()

Gets an audit search order. The AuditSearchOrder is supplied to an AuditSearch to specify the ordering of results.

Returns:

the audit search order

Compliance:

mandatory - This method must be implemented.

getAuditsBySearch

AuditSearchResults getAuditsBySearch(AuditQuery auditQuery,
 AuditSearch auditSearch)
                              throws OperationFailedException,
PermissionDeniedException

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

Parameters:

auditQuery - the audit query

auditSearch - the audit search

Returns:

the audit search results

Throws:

NullArgumentException - auditQuery or auditSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - auditQuery or auditSearch is not of this service

Compliance:

mandatory - This method must be implemented.

getAuditQueryFromInspector

AuditQuery getAuditQueryFromInspector(AuditQueryInspector auditQueryInspector)

Gets an audit query from an inspector. The inspector is available from an AuditSearchResults .

Parameters:

auditQueryInspector - an audit query inspector

Returns:

the audit query

Throws:

NullArgumentException - auditQueryInspector is null

UnsupportedException - auditQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.