Interface | osid.mapping.MapAdminSession | ||
---|---|---|---|
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 | canCreateMaps | ||
Description |
Tests if this user can create | ||
Return | boolean | false if Map creation is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | canCreateMapWithRecordTypes | ||
Description |
Tests if this user can create a single | ||
Parameters | osid.type.Type[] | mapRecordTypes | array of map record types |
Return | boolean | true if Map creation using the specified
record Types is supported, false otherwise | |
Errors | NULL_ARGUMENT | mapRecordTypes is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getMapFormForCreate | ||
Description |
Gets the map form for creating new maps. A new form should be requested for each create transaction. | ||
Parameters | osid.type.Type[] | mapRecordTypes | array of map record types |
Return | osid.mapping.MapForm | the map form | |
Errors | NULL_ARGUMENT | mapRecordTypes is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | unable to get a form with given record types | ||
Compliance | mandatory | This method must be implemented. | |
Method | createMap | ||
Description |
Creates a new | ||
Parameters | osid.mapping.MapForm | mapForm | the form for this Map |
Return | osid.mapping.Map | the new Map | |
Errors | ILLEGAL_STATE | mapForm already used in a create transaction | |
INVALID_ARGUMENT | one or more of the form elements is invalid | ||
NULL_ARGUMENT | mapForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | mapForm did not originate from getMapFormForCreate()
| ||
Compliance | mandatory | This method must be implemented. | |
Method | canUpdateMaps | ||
Description |
Tests if this user can update | ||
Return | boolean | false if Map modification is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getMapFormForUpdate | ||
Description |
Gets the map form for updating an existing map. A new map form should be requested for each update transaction. | ||
Parameters | osid.id.Id | mapId | the Id of the Map |
Return | osid.mapping.MapForm | the map form | |
Errors | NOT_FOUND | mapId is not found | |
NULL_ARGUMENT | mapId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateMap | ||
Description |
Updates an existing map | ||
Parameters | osid.mapping.MapForm | mapForm | the form containing the elements to be updated |
Errors | ILLEGAL_STATE | mapForm already used in an update transaction | |
INVALID_ARGUMENT | the form contains an invalid value | ||
NULL_ARGUMENT | mapId or mapForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | mapForm did not originate from getMapFormForUpdate()
| ||
Compliance | mandatory | This method must be implemented. | |
Method | canDeleteMaps | ||
Description |
Tests if this user can delete | ||
Return | boolean | false if Map deletion is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | deleteMap | ||
Description |
Deletes a | ||
Parameters | osid.id.Id | mapId | the Id of the Map to remove |
Errors | NOT_FOUND | mapId not found | |
NULL_ARGUMENT | mapId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canManageMapAliases | ||
Description |
Tests if this user can manage | ||
Return | boolean | false if Map aliasing is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | aliasMap | ||
Description |
Adds an | ||
Parameters | osid.id.Id | mapId | the Id of a Map |
osid.id.Id | aliasId | the alias Id | |
Errors | ALREADY_EXISTS | aliasId is already assigned | |
NOT_FOUND | mapId not found | ||
NULL_ARGUMENT | mapId or aliasId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |