public interface InquirySmartInquestSession extends OsidSession
This session manages queries and sequencing to create "smart" dynamic
catalogs. Sn InquiryQuery
can be retrieved from this
session and inquestped to this Inquest
to create a virtual
collection of Inquiries.
The inquiries may be sequenced
using the InquirySearchOrder
from this session.
This Inquest
has a default query that matches any
inquiry and a default search order that specifies no sequencing. The
queries may be examined using an InquiryQueryInspector.
The
query may be modified by converting the inspector back to an
InquiryQuery.
Modifier and Type | Method and Description |
---|---|
void |
applyInquiryQuery(InquiryQuery inquiryQuery)
Applies an inquiry query to this inquest.
|
void |
applyInquirySequencing(InquirySearchOrder inquirySearchOrder)
Applies an inquiry 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. |
InquiryQuery |
getInquiryQuery()
Gets an inquiry query.
|
InquiryQuery |
getInquiryQueryFromInspector(InquiryQueryInspector inquiryQueryInspector)
Gets an inquiry query from an inspector.
|
InquirySearchOrder |
getInquirySearchOrder()
Gets an inquiry search order.
|
InquiryQueryInspector |
inspectInquiryQuery()
Gets an inquiry 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. InquiryQuery getInquiryQuery()
mandatory
- This method must be implemented. InquirySearchOrder getInquirySearchOrder()
mandatory
- This method must be implemented. void applyInquiryQuery(InquiryQuery inquiryQuery) throws OperationFailedException, PermissionDeniedException
inquiryQuery
- the inquiry queryNullArgumentException
- inquiryQuery
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- inquiryQuery
not
of this servicemandatory
- This method must be implemented. InquiryQueryInspector inspectInquiryQuery() throws OperationFailedException, PermissionDeniedException
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. void applyInquirySequencing(InquirySearchOrder inquirySearchOrder) throws OperationFailedException, PermissionDeniedException
inquirySearchOrder
- the inquiry search orderNullArgumentException
- inquirySearchOrder
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- inquirySearchOrder
not of this servicemandatory
- This method must be implemented. InquiryQuery getInquiryQueryFromInspector(InquiryQueryInspector inquiryQueryInspector)
inquiryQueryInspector
- an inquiry query inspectorNullArgumentException
- inquiryQueryInspector
is null
UnsupportedException
- inquiryQueryInspector
is not of this servicemandatory
- This method must be implemented.