OSID - osid.dictionary.EntryLookupSession Service Interface Definition

Interface	osid.dictionary.EntryLookupSession
Implements	`osid.OsidSession`
Used By	`osid.dictionary.DictionaryManager`
Used By	`osid.dictionary.DictionaryProxyManager`
Description	`EntryLookupSession` is used to look up dictionary entries. This session includes the methods defined in the `EntryRetrievalSession` . 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 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 Generally, the comparative view should be used for most applications as it permits operation even if there is data out of sync or there is an authorization block in a particular element.
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	useComparativeEntryView
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	usePlenaryEntryView
Description	A complete view of the `Entry` 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	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	getEntry
Description	Gets the `Entry` specified by its `Id` . The identifier represents the union of the key, keyType and valueType.In plenary mode, the exact `Id` is found or a `NOT_FOUND` results. Otherwise, the returned `Entry` may have a different `Id` than requested, such as the case where a duplicate `Id` was assigned to an `Agency` and retained for compatibility.
Parameters	`osid.id.Id`	`entryId`	`Id` of the `Entry`
Return	`osid.dictionary.Entry`		the entry
Errors	NOT_FOUND		`entryId` not found
	NULL_ARGUMENT		`entryId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method is must be implemented.
Method	getEntriesByIds
Description	Gets an `EntryList` corresponding to the given `IdList` . In plenary mode, the returned list contains all of the entries 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 `Entry` elements may be omitted from the list and may present the elements in any order including returning a unique set.
Parameters	`osid.id.IdList`	`entryIds`	a list of `Entry Ids`
Return	`osid.dictionary.EntryList`		the entry list
Errors	NOT_FOUND		`entryId` not found
	NULL_ARGUMENT		`entryIds` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method is must be implemented.
Method	getEntriesByGenusType
Description	Gets an `EntryList` corresponding to the given entry genus `Type` which does not include entries of genus types derived from the specified `Type` . In plenary mode, the returned list contains all known entries or an error results. Otherwise, the returned list may contain only those entries that are accessible through this session.
Parameters	`osid.type.Type`	`entryGenusType`	an entry genus type
Return	`osid.dictionary.EntryList`		the returned `Entry list`
Errors	NULL_ARGUMENT		`entryGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getEntriesByParentGenusType
Description	Gets an `EntryList` corresponding to the given entry genus `Type` and include any additional entries with genus types derived from the specified `Type` . In plenary mode, the returned list contains all known entries or an error results. Otherwise, the returned list may contain only those entries that are accessible through this session.
Parameters	`osid.type.Type`	`entryGenusType`	an entry genus type
Return	`osid.dictionary.EntryList`		the returned `Entry list`
Errors	NULL_ARGUMENT		`entryGenusType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getEntriesByRecordType
Description	Gets an `EntryList` containing the given entry record `Type` . In plenary mode, the returned list contains all known entries or an error results. Otherwise, the returned list may contain only those entries that are accessible through this session.
Parameters	`osid.type.Type`	`entryyRecordType`	an entry record type
Return	`osid.dictionary.EntryList`		the returned `Entry` list
Errors	NULL_ARGUMENT		`entryRecordType` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getEntriesByKeyType
Description	Gets all the `Dictionary` entries matching the given key `Type` . In plenary mode, the returned list contains all of the entries 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 Entry elements may be omitted from the list and may present the elements in any order including returning a unique set.
Parameters	`osid.type.Type`	`keyType`	the type of the key to match
Return	`osid.dictionary.EntryList`		the list of entries matching `keyType`
Errors	NULL_ARGUMENT		`keyType` is null
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getEntriesByKeyTypeAndValueType
Description	Gets all the `Dictionary` entries matching the given key and value `Type` . In plenary mode, the returned list contains all of the entries 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 Entry elements may be omitted from the list and may present the elements in any order including returning a unique set.
Parameters	`osid.type.Type`	`keyType`	the type of the key to match
Parameters	`osid.type.Type`	`valueType`	the type of the value to match
Return	`osid.dictionary.EntryList`		the list of entries matching `keyType`
Errors	NULL_ARGUMENT		`keyType` or `valueType` is null
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getEntriesByKeyAndKeyType
Description	Gets all the `Dictionary` entries matching the given key and key `Type` . In plenary mode, the returned list contains all of the entries 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 Entry elements may be omitted from the list and may present the elements in any order including returning a unique set.
Parameters	`object`	`key`	the key to match
Parameters	`osid.type.Type`	`keyType`	the type of the value to match
Return	`osid.dictionary.EntryList`		the list of entries matching `keyType`
Errors	NULL_ARGUMENT		`key` or `keyType` is null
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	getEntries
Description	Gets all `Entry` elements. In plenary mode, the returned list contains all known entries or an error results. Otherwise, the returned list may contain only those dictionaries that are accessible through this session.
Return	`osid.dictionary.EntryList`		the list of entries
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.