Interface EntryRetrievalSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface EntryRetrievalSession
extends OsidSession

EntryRetrievalSession is used to get 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.

Method Summary

Modifier and Type	Method	Description
boolean	canRetrieveEntries()	Tests if this user can perform Entry retrievals.
Dictionary	getDictionary()	Gets the Dictionary associated with this session.
Id	getDictionaryId()	Gets the Dictionary Id associated with this session.
Object	retrieveEntry(Object key, Type keyType, Type valueType)	Gets the Dictionary entry associated with the given key and types.

Methods inherited from interface Closeable

close

Methods inherited from interface OsidSession

close

Modifier and Type	Method	Description
void	close()	Close this session.

Methods inherited from interface OsidSession

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

Modifier and Type	Method	Description
Agent	getAuthenticatedAgent()	Gets the agent authenticated to this session.
Id	getAuthenticatedAgentId()	Gets the Id of the agent authenticated to this session.
BigDecimal	getClockRate()	Gets the rate of the service clock.
Date	getDate()	Gets the service date which may be the current date or the effective date in which this session exists.
Agent	getEffectiveAgent()	Gets the effective agent in use by this session.
Id	getEffectiveAgentId()	Gets the Id of the effective agent in use by this session.
Type	getFormatType()	Gets the DisplayText format Type preference in effect for this session.
Locale	getLocale()	Gets the locale indicating the localization preferences in effect for this session.
boolean	isAuthenticated()	Tests if an agent is authenticated to this session.
Transaction	startTransaction()	Starts a new transaction for this sesson.
boolean	supportsTransactions()	Tests for the availability of transactions.

Method Details

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.

canRetrieveEntries

boolean canRetrieveEntries()

Tests if this user can perform Entry retrievals. 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 retrieval methods are not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

retrieveEntry

Object retrieveEntry(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.