org.osid.inquiry.rules

Interface InquiryEnablerSmartInquestSession

All Superinterfaces:

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

public interface InquiryEnablerSmartInquestSession
extends OsidSession

This session manages queries and sequencing to create "smart" dynamic inquests. An InquiryEnablerQuery can be retrieved from this session and mapped to this Inquest to create a virtual collection of inquiry enablers. The inquiry enablers may be sequenced using the InquiryEnablerSearchOrder from this session.

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

Method Summary

Methods

Modifier and Type	Method and Description
void	applyInquiryEnablerQuery(InquiryEnablerQuery inquiryEnablerQuery) Applies an inquiry enabler query to this inquest.
void	applyInquiryEnablerSequencing(InquiryEnablerSearchOrder inquiryEnablerSearchOrder) Applies an inquiry enabler search order to this inquest.
boolean	canManageSmartInquests() Tests if this user can manage smart inquests.
Inquest	getInquest() Gets the Inquest associated with this session.
Id	getInquestId() Gets the Inquest Id associated with this session.
InquiryEnablerQuery	getInquiryEnablerQuery() Gets an inquiry enabler query.
InquiryEnablerQuery	getInquiryEnablerQueryFromInspector(InquiryEnablerQueryInspector inquiryEnablerQueryInspector) Gets an inquiry enabler query from an inspector.
InquiryEnablerSearchOrder	getInquiryEnablerSearchOrder() Gets an inquiry enabler search order.
InquiryEnablerQueryInspector	inspectInquiryEnablerQuery() Gets an inquiry enabler 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.

getInquiryEnablerQuery

InquiryEnablerQuery getInquiryEnablerQuery()

Gets an inquiry enabler query.

Returns:

the inquiry enabler query

Compliance:

mandatory - This method must be implemented.

getInquiryEnablerSearchOrder

InquiryEnablerSearchOrder getInquiryEnablerSearchOrder()

Gets an inquiry enabler search order.

Returns:

the inquiry enabler search order

Compliance:

mandatory - This method must be implemented.

applyInquiryEnablerQuery

void applyInquiryEnablerQuery(InquiryEnablerQuery inquiryEnablerQuery)
                              throws OperationFailedException,
                                     PermissionDeniedException

Applies an inquiry enabler query to this inquest.

Parameters:

inquiryEnablerQuery - the inquiry enabler query

Throws:

NullArgumentException - inquiryEnablerQuery is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - inquiryEnablerQuery not of this service

Compliance:

mandatory - This method must be implemented.

inspectInquiryEnablerQuery

InquiryEnablerQueryInspector inspectInquiryEnablerQuery()
                                                        throws OperationFailedException,
                                                               PermissionDeniedException

Gets an inquiry enabler query inspector for this inquest.

Returns:

the inquiry enabler query inspector

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

Compliance:

mandatory - This method must be implemented.

applyInquiryEnablerSequencing

void applyInquiryEnablerSequencing(InquiryEnablerSearchOrder inquiryEnablerSearchOrder)
                                   throws OperationFailedException,
                                          PermissionDeniedException

Applies an inquiry enabler search order to this inquest.

Parameters:

inquiryEnablerSearchOrder - the inquiry enabler search order

Throws:

NullArgumentException - inquiryEnablerSearchOrder is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure occurred

UnsupportedException - inquiryEnablerSearchOrder not of this service

Compliance:

mandatory - This method must be implemented.

getInquiryEnablerQueryFromInspector

InquiryEnablerQuery getInquiryEnablerQueryFromInspector(InquiryEnablerQueryInspector inquiryEnablerQueryInspector)

Gets an inquiry enabler query from an inspector.

Parameters:

inquiryEnablerQueryInspector - an inquiry enabler query inspector

Returns:

the inquiry enabler query

Throws:

NullArgumentException - inquiryEnablerQueryInspector is null

UnsupportedException - inquiryEnablerQueryInspector is not of this service

Compliance:

mandatory - This method must be implemented.