OSID - osid.dictionary.EntryRetrievalSession Service Interface Definition

Interface	osid.dictionary.EntryRetrievalSession
Implements	`osid.OsidSession`
Description	`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	getDictionaryId
Description	Gets the `Dictionary` `Id` associated with this session.
Return	`osid.id.Id`		the `Dictionary` `Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getDictionary
Description	Gets the `Dictionary` associated with this session.
Return	`osid.dictionary.Dictionary`		the `Dictionary` associated with this session
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canLookupEntries
Description	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.
Return	`boolean`		`false` if lookup methods are not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	useFederatedDictionaryView
Description	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.
Method	useIsolatedDictionaryView
Description	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.
Method	retrieveEntry
Description	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	`object`	`key`	the key of the entry to retrieve
	`osid.type.Type`	`keyType`	the key type of the entry to retrieve
	`osid.type.Type`	`valueType`	the value type of the entry to retrieve
Return	`object`		the returned `object`
Errors	INVALID_ARGUMENT		`key` is not of `keyType`
	NOT_FOUND		no entry found
	NULL_ARGUMENT		`key, keyType,` or `valueType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.