OSID - osid.dictionary.EntryDictionarySession Service Interface Definition

Interface	osid.dictionary.EntryDictionarySession
Implements	`osid.OsidSession`
Used By	`osid.dictionary.DictionaryManager`
Used By	`osid.dictionary.DictionaryProxyManager`
Description	This session provides methods to retrieve `Entry` to `Dictionary` mappings. An `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: comparative view: elements may be silently omitted or re-ordered plenary view: provides a complete result set or is an error condition
Method	useComparativeDictionaryView
Description	The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision.
Compliance	`mandatory`		This method is must be implemented.
Method	usePlenaryDictionaryView
Description	A complete view of the `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.
Compliance	`mandatory`		This method is must be implemented.
Method	canLookupEntryDictionaryMappings
Description	Tests if this user can perform lookups of entry/dictionary mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known lookup 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 looking up mappings is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getEntryIdsByDictionary
Description	Gets the list of `Entry` `Ids` associated with a `Dictionary` .
Parameters	`osid.id.Id`	`dictionaryId`	`Id` of a `Dictionary`
Return	`osid.id.IdList`		list of related entry `Ids`
Errors	NOT_FOUND		`dictionaryId` is not found
	NULL_ARGUMENT		`dictionaryId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getEntriesByDictionary
Description	Gets the list of dictionary entries associated with a `Dictionary` .
Parameters	`osid.id.Id`	`dictionaryId`	`Id` of a `Dictionary`
Return	`osid.dictionary.EntryList`		list of related entries
Errors	NOT_FOUND		`dictionaryId` is not found
	NULL_ARGUMENT		`dictionaryId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getEntryIdsByDictionaries
Description	Gets the list of `Entry Ids` corresponding to a list of `Dictionary` objects.
Parameters	`osid.id.IdList`	`dictionaryIds`	list of dictionary `Ids`
Return	`osid.id.IdList`		list of entry `Ids`
Errors	NULL_ARGUMENT		`dictionaryIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getEntriesByDictionaries
Description	Gets the list of entries corresponding to a list of dictioanries.
Parameters	`osid.id.IdList`	`dictionaryIds`	list of dictionary `Ids`
Return	`osid.dictionary.EntryList`		list of entries
Errors	NULL_ARGUMENT		`dictionaryIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getDictionaryIdsByEntry
Description	Gets the list of `Dictionary` `Ids` mapped to an `Entry` .
Parameters	`osid.id.Id`	`entryId`	`Id` of an `Entry`
Return	`osid.id.IdList`		list of dictionary `Ids`
Errors	NOT_FOUND		`entryId` is not found
	NULL_ARGUMENT		`entryId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getDictionariesByEntry
Description	Gets the list of `Dictionary` objects mapped to an `Entry` .
Parameters	`osid.id.Id`	`entryId`	`Id` of an `Entry`
Return	`osid.dictionary.DictionaryList`		list of dictionaries
Errors	NOT_FOUND		`entryId` is not found
	NULL_ARGUMENT		`entryId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.