public interface EntryDictionarySession extends OsidSession
This session provides methods to retrieve Entry
to
Dictionary
mappings. A Entry
may appear in
multiple dictionaries .
Each Dictionary
may
have its own authorizations governing who is allowed to look at it.
This lookup session defines several views:
Modifier and Type | Method and Description |
---|---|
boolean |
canLookupEntryDictionaryMappings()
Tests if this user can perform lookups of entry/dictionary mappings.
|
DictionaryList |
getDictionariesByEntry(Id entryId)
Gets the list of
Dictionary objects mapped to a
Entry. |
IdList |
getDictionaryIdsByEntry(Id entryId)
Gets the list of
Dictionary Ids mapped
to a Entry. |
EntryList |
getEntriesByDictionaries(IdList dictionaryIds)
Gets the list of entries corresponding to a list of dictioanries.
|
EntryList |
getEntriesByDictionary(Id dictionaryId)
Gets the list of dictionary entries associated with a
Dictionary. |
IdList |
getEntryIdsByDictionaries(IdList dictionaryIds)
Gets the list of
Entry Ids corresponding to a list of
Dictionary objects. |
IdList |
getEntryIdsByDictionary(Id dictionaryId)
Gets the list of
Entry Ids associated
with a Dictionary. |
void |
useComparativeDictionaryView()
The returns from the lookup methods may omit or translate elements
based on this session, such as authorization, and not result in an
error.
|
void |
usePlenaryDictionaryView()
A complete view of the
Entry and Dictionary
returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
void useComparativeDictionaryView()
mandatory
- This method is must be implemented. void usePlenaryDictionaryView()
Entry
and Dictionary
returns is desired. Methods will return what is requested or
result in an error. This view is used when greater precision is
desired at the expense of interoperability.mandatory
- This method is must be implemented. boolean canLookupEntryDictionaryMappings()
PERMISSION_DENIED.
This is intended as
a hint to an application that may opt not to offer lookup operations
to unauthorized users. false
if looking up mappings is not authorized,
true
otherwisemandatory
- This method must be implemented. IdList getEntryIdsByDictionary(Id dictionaryId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Entry
Ids
associated
with a Dictionary.
dictionaryId
- Id
of a Dictionary
Ids
NotFoundException
- dictionaryId
is not
foundNullArgumentException
- dictionaryId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. EntryList getEntriesByDictionary(Id dictionaryId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Dictionary.
dictionaryId
- Id
of a Dictionary
NotFoundException
- dictionaryId
is not
foundNullArgumentException
- dictionaryId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IdList getEntryIdsByDictionaries(IdList dictionaryIds) throws OperationFailedException, PermissionDeniedException
Entry Ids
corresponding to a list of
Dictionary
objects.dictionaryIds
- list of dictionary Ids
Ids
NullArgumentException
- dictionaryIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. EntryList getEntriesByDictionaries(IdList dictionaryIds) throws OperationFailedException, PermissionDeniedException
dictionaryIds
- list of dictionary Ids
NullArgumentException
- dictionaryIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IdList getDictionaryIdsByEntry(Id entryId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Dictionary
Ids
mapped
to a Entry.
entryId
- Id
of a Entry
Ids
NotFoundException
- entryId
is not foundNullArgumentException
- entryId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. DictionaryList getDictionariesByEntry(Id entryId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Dictionary
objects mapped to a
Entry.
entryId
- Id
of a Entry
NotFoundException
- entryId
is not foundNullArgumentException
- entryId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.