org.osid.dictionary

Interface EntryRetrievalSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidSession

All Known Subinterfaces:

EntryLookupSession

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.

• federated view: entries are accessible from the Dictionary associated with this session and any descedant dictionaries in the Dictionary hierarchy
• isolated view: entries are accessible from this Dictionary only

Method Summary

Methods

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.

Methods inherited from interface org.osid.OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

getDictionaryId

Id getDictionaryId()

Gets the Dictionary Id associated with this session.

Returns:

the Dictionary Id associated with this session

Compliance:

mandatory - This method must be implemented.

getDictionary

Dictionary getDictionary()
                         throws OperationFailedException,
                                PermissionDeniedException

Gets the Dictionary associated with this session.

Returns:

the Dictionary associated with this session

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canLookupEntries

boolean canLookupEntries()

Tests if this user can perform 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.

Returns:

false if lookup methods are not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

useFederatedDictionaryView

void useFederatedDictionaryView()

Federates the view for methods in this session. A federated view will include entries from descendant dictionaries in the dictionary hierarchy.

Compliance:

mandatory - This method is must be implemented.

useIsolatedDictionaryView

void useIsolatedDictionaryView()

Isolates the view for methods in this session. An isolated view restricts lookups to this dictionary only.

Compliance:

mandatory - This method is must be implemented.

retrieveEntry

java.lang.Object retrieveEntry(java.lang.Object key,
                             Type keyType,
                             Type valueType)
                               throws NotFoundException,
                                      OperationFailedException,
                                      PermissionDeniedException

Gets the Dictionary entry associated with the given key and types. The keyType indicates the key object type and the valueType indicates the value object return.

Parameters:

key - the key of the entry to retrieve

keyType - the key type of the entry to retrieve

valueType - the value type of the entry to retrieve

Returns:

the returned object

Throws:

InvalidArgumentException - key is not of keyType

NotFoundException - no entry found

NullArgumentException - key, keyType, or valueType is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.