OSID Logo
OSID Specifications
dictionary package
Version 3.0.0
Release Candidate Preview
Interfaceosid.dictionary.DictionaryLookupSession
Implementsosid.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.

MethodcanLookupDictionaries
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.

Returnboolean false if lookup methods are not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoduseComparativeDictionaryView
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.

CompliancemandatoryThis method is must be implemented.
MethodusePlenaryDictionaryView
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.

CompliancemandatoryThis method is must be implemented.
MethodgetDictionary
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.

Parametersosid.id.IddictionaryIdthe Id of the Dictionary to retrieve
Returnosid.dictionary.Dictionarythe Dictionary
ErrorsNOT_FOUNDno Dictionary found with the given Id
NULL_ARGUMENT Id is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetDictionariesByIds
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.

Parametersosid.id.IdListdictionaryIdsthe list of Ids to retrieve
Returnosid.dictionary.DictionaryListthe returned Dictionary list
ErrorsNOT_FOUNDan Id was not found
NULL_ARGUMENT dictionaryIds is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetDictionariesByGenusType
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.

Parametersosid.type.TypedictionaryGenusTypea dictionary genus type
Returnosid.dictionary.DictionaryListthe returned Dictionary list
ErrorsNULL_ARGUMENT dictionaryGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetDictionariesByParentGenusType
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.

Parametersosid.type.TypedictionaryGenusTypea dictionary genus type
Returnosid.dictionary.DictionaryListthe returned Dictionary list
ErrorsNULL_ARGUMENT dictionaryGenusType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetDictionariesByRecordType
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.

Parametersosid.type.TypedictionaryRecordTypea dictionary record type
Returnosid.dictionary.DictionaryListthe returned Dictionary list
ErrorsNULL_ARGUMENT dictionaryRecordType is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetDictionariesByProvider
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.

Parametersosid.id.IdresourceIda resource Id
Returnosid.dictionary.DictionaryListthe returned Dictionary list
ErrorsNULL_ARGUMENT resourceId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodgetDictionaries
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.

Returnosid.dictionary.DictionaryLista list of dictionaries
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.