Interface | osid.dictionary.DictionaryLookupSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session provides methods for retrieving This session defines two views which offer differing behaviors when retrieving multiple objects.
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 | ||
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 | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getDictionary | ||
Description |
Gets the | ||
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 | ||
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 | ||
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 | ||
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 | ||
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 | ||
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 | ||
Return | osid.dictionary.DictionaryList | a list of dictionaries | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |