public interface EntrySmartDictionarySession extends OsidSession
This session manages queries and sequencing to create "smart" dynamic
catalogs. A EntryQuery
can be retrieved from this session
and mapped to this Dictionary
to create a virtual
collection of Entries.
The entries may be sequenced using
the EntrySearchOrder
from this session.
This Dictionary
has a default query that matches any
entry and a default search order that specifies no sequencing. The queries
may be examined using a EntryQueryInspector.
The query may
be modified by converting the inspector back to a EntryQuery.
Modifier and Type | Method and Description |
---|---|
void |
applyEntryQuery(EntryQuery entryQuery)
Applies a entry query to this dictionary.
|
void |
applyEntrySequencing(EntrySearchOrder entrySearchOrder)
Applies a entry search order to this dictionary.
|
boolean |
canManageSmartDictionaries()
Tests if this user can manage smart dictionarys.
|
Dictionary |
getDictionary()
Gets the
Dictionary associated with this session. |
Id |
getDictionaryId()
Gets the
Dictionary Id associated with
this session. |
EntryQuery |
getEntryQuery()
Gets a entry query.
|
EntryQuery |
getEntryQueryFromInspector(EntryQueryInspector entryQueryInspector)
Gets a entry query from an inspector.
|
EntrySearchOrder |
getEntrySearchOrder()
Gets a entry search order.
|
EntryQueryInspector |
inspectEntryQuery()
Gets a entry query inspector for this dictionary.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getDictionaryId()
Dictionary
Id
associated with
this session. Dictionary Id
associated with this sessionmandatory
- This method must be implemented. Dictionary getDictionary() throws OperationFailedException, PermissionDeniedException
Dictionary
associated with this session. Dictionary
associated with this sessionOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canManageSmartDictionaries()
PERMISSION_DENIED.
This is intended as a hint to an
application that may opt not to offer operations to unauthorized
users. false
if smart dictionary management is not
authorized, true
otherwisemandatory
- This method must be implemented. EntryQuery getEntryQuery()
mandatory
- This method must be implemented. EntrySearchOrder getEntrySearchOrder()
mandatory
- This method must be implemented. void applyEntryQuery(EntryQuery entryQuery) throws OperationFailedException, PermissionDeniedException
entryQuery
- the entry queryNullArgumentException
- entryQuery
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- entryQuery
not of
this servicemandatory
- This method must be implemented. EntryQueryInspector inspectEntryQuery() throws OperationFailedException, PermissionDeniedException
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredmandatory
- This method must be implemented. void applyEntrySequencing(EntrySearchOrder entrySearchOrder) throws OperationFailedException, PermissionDeniedException
entrySearchOrder
- the entry search orderNullArgumentException
- entrySearchOrder
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failure
occurredUnsupportedException
- entrySearchOrder
not of this servicemandatory
- This method must be implemented. EntryQuery getEntryQueryFromInspector(EntryQueryInspector entryQueryInspector)
entryQueryInspector
- a entry query inspectorNullArgumentException
- entryQueryInspector
is null
UnsupportedException
- entryQueryInspector
is not of this servicemandatory
- This method must be implemented.