org.osid.inquiry

Interface AuditSmartInquestSession

All Superinterfaces:

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

public interface AuditSmartInquestSession
extends OsidSession

This session manages queries and sequencing to create "smart" dynamic catalogs. An AuditQuery can be retrieved from this session and mapped to this Inquest to create a virtual collection of audits. The audits may be sequenced using the AuditSearchOrder from this session.

This Inquest has a default query that matches any audit and a default search order that specifies no sequencing. The queries may be examined using an AuditQueryInspector. The query may be modified by converting the inspector back to an AuditQuery.

Method Summary

Methods

Modifier and Type	Method and Description
void	applyAuditQuery(AuditQuery auditQuery) Applies an audit query to this inquest.
void	applyAuditSequencing(AuditSearchOrder auditSearchOrder) Applies an audit search order to this inquest.
boolean	canManageSmartInquests() Tests if this user can manage smart inquests.
AuditQuery	getAuditQuery() Gets an audit query.
AuditQuery	getAuditQueryFromInspector(AuditQueryInspector auditQueryInspector) Gets an audit query from an inspector.
AuditSearchOrder	getAuditSearchOrder() Gets an audit search order.
Inquest	getInquest() Gets the Inquest associated with this session.
Id	getInquestId() Gets the Inquest Id associated with this session.
AuditQueryInspector	inspecAuditQuery() Gets an audit query inspector for this inquest.

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

getInquestId

Id getInquestId()

Gets the Inquest Id associated with this session.

Returns:

the Inquest Id associated with this session

Compliance:

mandatory - This method must be implemented.

getInquest

Inquest getInquest()
                   throws OperationFailedException,
                          PermissionDeniedException

Gets the Inquest associated with this session.

Returns:

the inquest

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canManageSmartInquests

boolean canManageSmartInquests()

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

Returns:

false if smart inquest management is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

getAuditQuery

AuditQuery getAuditQuery()

Gets an audit query.

Returns:

the audit query

Compliance:

mandatory - This method must be implemented.

getAuditSearchOrder

AuditSearchOrder getAuditSearchOrder()

Gets an audit search order.

Returns:

the audit search order

Compliance:

mandatory - This method must be implemented.

applyAuditQuery

void applyAuditQuery(AuditQuery auditQuery)
                     throws OperationFailedException,
                            PermissionDeniedException

Applies an audit query to this inquest.

Parameters:

auditQuery - the audit query

Throws:

NullArgumentException - auditQuery is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - auditQuery not of this service

Compliance:

mandatory - This method must be implemented.

inspecAuditQuery

AuditQueryInspector inspecAuditQuery()
                                     throws OperationFailedException,
                                            PermissionDeniedException

Gets an audit query inspector for this inquest.

Returns:

the audit query inspector

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

Compliance:

mandatory - This method must be implemented.

applyAuditSequencing

void applyAuditSequencing(AuditSearchOrder auditSearchOrder)
                          throws OperationFailedException,
                                 PermissionDeniedException

Applies an audit search order to this inquest.

Parameters:

auditSearchOrder - the audit search order

Throws:

NullArgumentException - auditSearchOrder is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - auditSearchOrder not of this service

Compliance:

mandatory - This method must be implemented.

getAuditQueryFromInspector

AuditQuery getAuditQueryFromInspector(AuditQueryInspector auditQueryInspector)

Gets an audit query from an inspector.

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.