public interface EntryRetrievalSession extends OsidSession
EntryRetrievalSession
is used to query dictionary
entries. A dictionary entry contains a key and a value. The uniqeness of
the entry depends on the key, the key type and the value type.
This session defines two views which offer differing behaviors when retrieving multiple objects.
Dictionary
associated with this session and any descedant dictionaries in
the Dictionary
hierarchy Dictionary
only Modifier and Type | Method and Description |
---|---|
boolean |
canLookupEntries()
Tests if this user can perform
Entry lookups. |
Dictionary |
getDictionary()
Gets the
Dictionary associated with this session. |
Id |
getDictionaryId()
Gets the
Dictionary Id associated with
this session. |
java.lang.Object |
retrieveEntry(java.lang.Object key,
Type keyType,
Type valueType)
Gets the
Dictionary entry associated with the given key
and types. |
void |
useFederatedDictionaryView()
Federates the view for methods in this session.
|
void |
useIsolatedDictionaryView()
Isolates the view for methods in this session.
|
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 canLookupEntries()
Entry
lookups. A return
of true does not guarantee successful authorization. A return of false
indicates that it is known all 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 lookup operations to
unauthorized users. false
if lookup methods are not authorized,
true
otherwisemandatory
- This method must be implemented. void useFederatedDictionaryView()
mandatory
- This method is must be implemented. void useIsolatedDictionaryView()
mandatory
- This method is must be implemented. java.lang.Object retrieveEntry(java.lang.Object key, Type keyType, Type valueType) throws NotFoundException, OperationFailedException, PermissionDeniedException
Dictionary
entry associated with the given key
and types. The keyType
indicates the key object type
and the valueType
indicates the value object return.key
- the key of the entry to retrievekeyType
- the key type of the entry to retrievevalueType
- the value type of the entry to retrieve object
InvalidArgumentException
- key
is not of
keyType
NotFoundException
- no entry foundNullArgumentException
- key, keyType,
or
valueType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.