Interface | osid.dictionary.DictionaryAdminSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session creates, updates, and deletes Create and update operations differ in their usage. To
create a For updates, The delete operations delete This session includes an | ||
Method | canCreateDictionaries | ||
Description |
Tests if this user can create | ||
Return | boolean | false if Dictionary creation is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | canCreateDictionaryWithRecordTypes | ||
Description |
Tests if this user can create a single | ||
Parameters | osid.type.Type[] | dictionaryRecordTypes | array of dictionary record types |
Return | boolean | true if Dictionary creation using the
specified record Types is supported, false
otherwise | |
Errors | NULL_ARGUMENT | dictionaryRecordTypes is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getDictionaryFormForCreate | ||
Description |
Gets the dictionary form for creating new dictionaries. A new form should be requested for each create transaction. | ||
Parameters | osid.type.Type[] | dictionaryRecordTypes | array of dictionary record types |
Return | osid.dictionary.DictionaryForm | the dictionary form | |
Errors | NULL_ARGUMENT | dictionaryRecordTypes is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | unable to get form for requested record types | ||
Compliance | mandatory | This method must be implemented. | |
Method | createDictionary | ||
Description |
Creates a new | ||
Parameters | osid.dictionary.DictionaryForm | dictionaryForm | the form for the new Dictionary |
Return | osid.dictionary.Dictionary | the new Dictionary | |
Errors | ILLEGAL_STATE | dictionaryForm already used in a create transaction | |
INVALID_ARGUMENT | the form contains an invalid value | ||
NULL_ARGUMENT | dictionaryForms is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | dictionaryForm did not originate from
getDictionaryFormForCreate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canUpdateDictionaries | ||
Description |
Tests if this user can update | ||
Return | boolean | false if Dictionary modification is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getDictionaryFormForUpdate | ||
Description |
Gets the dictionary form for updating an existing dictionary. A new dictionary form should be requested for each update transaction. | ||
Parameters | osid.id.Id | dictionaryId | the Id of the Dictionary |
Return | osid.dictionary.DictionaryForm | the dictionary form | |
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 | updateDictionary | ||
Description |
Updates an existing dictionary. | ||
Parameters | osid.dictionary.DictionaryForm | dictionaryForm | the form containing the elements to be updated |
Errors | ILLEGAL_STATE | dictionaryForm already used in an update transaction | |
INVALID_ARGUMENT | the form contains an invalid value | ||
NULL_ARGUMENT | dictionaryForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | a dictionaryForm did not originate from
getDictionaryFormForUpdate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canDeleteDictionaries | ||
Description |
Tests if this user can delete | ||
Return | boolean | false if Dictionary deletion is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | deleteDictionary | ||
Description |
Deletes a | ||
Parameters | osid.id.Id | dictionaryId | the Id of the Dictionary to delete |
Errors | NOT_FOUND | dictionaryId 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 | canManageDictionaryAliases | ||
Description |
Tests if this user can manage | ||
Return | boolean | false if Dictionary aliasing is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | aliasDictionary | ||
Description |
Adds an | ||
Parameters | osid.id.Id | dictionaryId | the Id of an Dictionary |
osid.id.Id | aliasId | the alias Id | |
Errors | ALREADY_EXISTS | aliasId is already assigned | |
NOT_FOUND | dictionaryId not found | ||
NULL_ARGUMENT | dictionaryId or aliasId is null
| ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |