OSID - osid.dictionary.DictionaryLookupSession Service Interface Definition

Interface	osid.dictionary.DictionaryLookupSession
Implements	`osid.OsidSession`
Description	This session provides methods for retrieving `Dictionary` objects. The `Dictionary represents a` collection of key/value entries. This session defines two views which offer differing behaviors when retrieving multiple objects. comparative view: elements may be silently omitted or re-ordered plenary view: provides a complete and ordered result set or is an error condition Generally, the comparative view should be used for most applications as it permits operation even if there is data out of sync. For example, a hierarchy output can be plugged into a lookup method to retrieve all objects known to a hierarchy, but it may not be necessary to break execution if a node from the hierarchy no longer exists. However, some administrative applications may need to know whether it had retrieved an entire set of objects and may sacrifice some interoperability for the sake of precision.
Method	canLookupDictionaries
Description	Tests if this user can perform `Dictionary` 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	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 `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	getDictionary
Description	Gets the `Dictionary` specified by its `Id.` In plenary mode, the exact `Id` is found or a `NOT_FOUND` results. Otherwise, the returned `Dictionary` may have a different `Id` than requested, such as the case where a duplicate `Id` was assigned to a `Dictionary` and retained for compatibility.
Parameters	`osid.id.Id`	`dictionaryId`	the `Id` of the `Dictionary` to retrieve
Return	`osid.dictionary.Dictionary`		the `Dictionary`
Errors	NOT_FOUND		no `Dictionary` found with the given `Id`
	NULL_ARGUMENT		`Id` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getDictionariesByIds
Description	Gets a `DictionaryList` corresponding to the given `IdList.` In plenary mode, the returned list contains all of the dictionaries specified in the `Id` list, in the order of the list, including duplicates, or an error results if an `Id` in the supplied list is not found or inaccessible. Otherwise, inaccessible `Dictionary` elements may be omitted from the list and may present the elements in any order including returning a unique set.
Parameters	`osid.id.IdList`	`dictionaryIds`	the list of `Ids` to retrieve
Return	`osid.dictionary.DictionaryList`		the returned `Dictionary` list
Errors	NOT_FOUND		an `Id was` not found
	NULL_ARGUMENT		`dictionaryIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getDictionariesByGenusType
Description	Gets a `DictionaryList` corresponding to the given dictionary genus `Type` which does not include dictionaries of genus types derived from the specified `Type.` In plenary mode, the returned list contains all known dictionaries or an error results. Otherwise, the returned list may contain only those dictionaries that are accessible through this session.
Parameters	`osid.type.Type`	`dictionaryGenusType`	a dictionary genus type
Return	`osid.dictionary.DictionaryList`		the returned `Dictionary list`
Errors	NULL_ARGUMENT		`dictionaryGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getDictionariesByParentGenusType
Description	Gets a `DictionaryList` corresponding to the given dictionary genus `Type` and include any additional dictionaries with genus types derived from the specified `Type.` In plenary mode, the returned list contains all known dictionaries or an error results. Otherwise, the returned list may contain only those dictionaries that are accessible through this session.
Parameters	`osid.type.Type`	`dictionaryGenusType`	a dictionary genus type
Return	`osid.dictionary.DictionaryList`		the returned `Dictionary` list
Errors	NULL_ARGUMENT		`dictionaryGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getDictionariesByRecordType
Description	Gets a `DictionaryList` containing the given dictionary record `Type.` In plenary mode, the returned list contains all known dictionaries or an error results. Otherwise, the returned list may contain only those dictionaries that are accessible through this session.
Parameters	`osid.type.Type`	`dictionaryRecordType`	a dictionary record type
Return	`osid.dictionary.DictionaryList`		the returned `Dictionary` list
Errors	NULL_ARGUMENT		`dictionaryRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getDictionariesByProvider
Description	Gets a `DictionaryList` for the given provider `.` In plenary mode, the returned list contains all known dictionaries or an error results. Otherwise, the returned list may contain only those dictionaries that are accessible through this session.
Parameters	`osid.id.Id`	`resourceId`	a resource `Id`
Return	`osid.dictionary.DictionaryList`		the returned `Dictionary` list
Errors	NULL_ARGUMENT		`resourceId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getDictionaries
Description	Gets all `Dictionary` elements. In plenary mode, the returned list contains all known dictionaries or an error results. Otherwise, the returned list may contain only those dictionaries that are accessible through this session.
Return	`osid.dictionary.DictionaryList`		a list of dictionaries
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.