org.osid.inquiry.rules

Interface AuditEnablerSearchSession

All Superinterfaces:

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

public interface AuditEnablerSearchSession
extends AuditEnablerQuerySession

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

getAuditEnablersByQuery() is the basic search method and returns a list of AuditEnablers. A more advanced search may be performed with getAuditEnablersBySearch(). It accepts an AuditEnablerSearch in addition to the query for the purpose of specifying additional options affecting the entire search, such as inquiry. getAuditEnablersBySearch() returns an AuditEnablerSearchResults that can be used to access the resulting AuditEnablerList or be used to perform a search within the result set through AuditEnablerSearch.

This session defines views that offer differing behaviors for searching.

• federated inquest view: searches include audit enablers in inquests of which this inquest is an ancestor in the inquest hierarchy
• isolated inquest view: searches are restricted to audit enablers in this inquest

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

Method Summary

Methods

Modifier and Type	Method and Description
AuditEnablerQuery	getAuditEnablerQueryFromInspector(AuditEnablerQueryInspector auditEnablerQueryInspector) Gets an audit enabler query from an inspector.
AuditEnablerSearchResults	getAuditEnablersBySearch(AuditEnablerQuery auditEnablerQuery, AuditEnablerSearch auditEnablerSearch) Gets the search results matching the given search query using the given search.
AuditEnablerSearch	getAuditEnablerSearch() Gets an audit enabler search.
AuditEnablerSearchOrder	getAuditEnablerSearchOrder() Gets an audit enabler search order.

Methods inherited from interface org.osid.inquiry.rules.AuditEnablerQuerySession

canSearchAuditEnablers, getAuditEnablerQuery, getAuditEnablersByQuery, getInquest, getInquestId, useFederatedInquestView, useIsolatedInquestView

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

getAuditEnablerSearch

AuditEnablerSearch getAuditEnablerSearch()

Gets an audit enabler search.

Returns:

the audit enabler search

Compliance:

mandatory - This method must be implemented.

getAuditEnablerSearchOrder

AuditEnablerSearchOrder getAuditEnablerSearchOrder()

Gets an audit enabler search order. The AuditEnablerSearchOrder is supplied to an AuditEnablerSearch to specify the ordering of results.

Returns:

the audit enabler search order

Compliance:

mandatory - This method must be implemented.

getAuditEnablersBySearch

AuditEnablerSearchResults getAuditEnablersBySearch(AuditEnablerQuery auditEnablerQuery,
                                                 AuditEnablerSearch auditEnablerSearch)
                                                   throws OperationFailedException,
                                                          PermissionDeniedException

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

Parameters:

auditEnablerQuery - the audit enabler query

auditEnablerSearch - the audit enabler search

Returns:

the returned search results

Throws:

NullArgumentException - auditEnablerQuery or auditEnablerSearch is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - auditEnablerQuery or auditEnablerSearch is not of this service

Compliance:

mandatory - This method must be implemented.

getAuditEnablerQueryFromInspector

AuditEnablerQuery getAuditEnablerQueryFromInspector(AuditEnablerQueryInspector auditEnablerQueryInspector)

Gets an audit enabler query from an inspector. The inspector is available from an AuditEnablerSearchResults.

Parameters:

auditEnablerQueryInspector - an audit enabler query inspector

Returns:

the audit enabler query

Throws:

NullArgumentException - auditEnablerQueryInspector is null

UnsupportedException - auditEnablerQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.