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.
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.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getInquestId()
Inquest
Id
associated with this
session. Inquest Id
associated with this sessionmandatory
- This method must be implemented. Inquest getInquest() throws OperationFailedException, PermissionDeniedException
Inquest
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canManageSmartInquests()
PERMISSION_DENIED.
This is intended as a hint to an
application that may opt not to offer operations to unauthorized
users. false
if smart inquest management is not
authorized, true
otherwisemandatory
- This method must be implemented. InquiryEnablerQuery getInquiryEnablerQuery()
mandatory
- This method must be implemented. InquiryEnablerSearchOrder getInquiryEnablerSearchOrder()
mandatory
- This method must be implemented. void applyInquiryEnablerQuery(InquiryEnablerQuery inquiryEnablerQuery) throws OperationFailedException, PermissionDeniedException
inquiryEnablerQuery
- the inquiry enabler queryNullArgumentException
- inquiryEnablerQuery
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- inquiryEnablerQuery
not of this servicemandatory
- This method must be implemented. InquiryEnablerQueryInspector inspectInquiryEnablerQuery() throws OperationFailedException, PermissionDeniedException
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. void applyInquiryEnablerSequencing(InquiryEnablerSearchOrder inquiryEnablerSearchOrder) throws OperationFailedException, PermissionDeniedException
inquiryEnablerSearchOrder
- the inquiry enabler search orderNullArgumentException
-
inquiryEnablerSearchOrder
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- inquiryEnablerSearchOrder
not of this servicemandatory
- This method must be implemented. InquiryEnablerQuery getInquiryEnablerQueryFromInspector(InquiryEnablerQueryInspector inquiryEnablerQueryInspector)
inquiryEnablerQueryInspector
- an inquiry enabler query
inspectorNullArgumentException
-
inquiryEnablerQueryInspector
is null
UnsupportedException
-
inquiryEnablerQueryInspector
is not of this servicemandatory
- This method must be implemented.