Interface | osid.mapping.path.PathAdminSession | ||
---|---|---|---|
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 | getMapId | ||
Description |
Gets the | ||
Return | osid.id.Id | the Map Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getMap | ||
Description |
Gets the | ||
Return | osid.mapping.Map | the map | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canCreatePaths | ||
Description |
Tests if this user can create | ||
Return | boolean | false if Path creation is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | canCreatePathWithRecordTypes | ||
Description |
Tests if this user can create a single | ||
Parameters | osid.type.Type[] | pathRecordTypes | array of path record types |
Return | boolean | true if Path creation using the specified
record Types is supported, false otherwise | |
Errors | NULL_ARGUMENT | pathRecordTypes is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getPathFormForCreate | ||
Description |
Gets the path form for creating new paths. A new form should be requested for each create transaction. | ||
Parameters | osid.type.Type[] | pathRecordTypes | array of path record types |
Return | osid.mapping.path.PathForm | the path form | |
Errors | NULL_ARGUMENT | pathRecordTypes 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 | createPath | ||
Description |
Creates a new | ||
Parameters | osid.mapping.path.PathForm | pathForm | the form for this Path |
Return | osid.mapping.path.Path | the new Path | |
Errors | ILLEGAL_STATE | pathForm already used in a create transaction | |
INVALID_ARGUMENT | one or more of the form elements is invalid | ||
NULL_ARGUMENT | pathForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | pathForm did not originate from
getPathFormForCreate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canUpdatePaths | ||
Description |
Tests if this user can update | ||
Return | boolean | false if Path modification is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getPathFormForUpdate | ||
Description |
Gets the path form for updating an existing path. A new path form should be requested for each update transaction. | ||
Parameters | osid.id.Id | pathId | the Id of the Path |
Return | osid.mapping.path.PathForm | the path form | |
Errors | NOT_FOUND | pathId is not found | |
NULL_ARGUMENT | pathId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updatePath | ||
Description |
Updates an existing path. | ||
Parameters | osid.mapping.path.PathForm | pathForm | the form containing the elements to be updated |
Errors | ILLEGAL_STATE | pathForm already used in an update transaction | |
INVALID_ARGUMENT | the form contains an invalid value | ||
NULL_ARGUMENT | pathForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | pathForm did not originate from
getPathFormForUpdate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canDeletePaths | ||
Description |
Tests if this user can delete | ||
Return | boolean | false if Path deletion is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | deletePath | ||
Description |
Deletes a | ||
Parameters | osid.id.Id | pathId | the Id of the Path to remove |
Errors | NOT_FOUND | pathId not found | |
NULL_ARGUMENT | pathId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canManagePathAliases | ||
Description |
Tests if this user can manage | ||
Return | boolean | false if Path aliasing is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | aliasPath | ||
Description |
Adds an | ||
Parameters | osid.id.Id | pathId | the Id of a Path |
osid.id.Id | aliasId | the alias Id | |
Errors | ALREADY_EXISTS | aliasId is already assigned | |
NOT_FOUND | pathId not found | ||
NULL_ARGUMENT | pathId or aliasId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |