Interface | osid.mapping.path.PathMapAssignmentSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session provides methods to re-assign Adding a reference of a | ||
Method | canAssignPaths | ||
Description |
Tests if this user can alter path/map mappings. A
return of true does not guarantee successful
authorization. A return of false indicates that it is
known location methods in this session will result in a
| ||
Return | boolean | false if mapping is not authorized, true
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | canAssignPathsToMap | ||
Description |
Tests if this user can alter path/map mappings. A
return of true does not guarantee successful
authorization. A return of false indicates that it is
known location methods in this session will result in a
| ||
Parameters | osid.id.Id | mapId | the Id of the Map |
Return | boolean | false if mapping is not authorized, true
otherwise | |
Errors | NULL_ARGUMENT | mapId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getAssignableMapIds | ||
Description |
Gets a list of maps including and under the given map node in which any path can be assigned. | ||
Parameters | osid.id.Id | mapId | the Id of the Map |
Return | osid.id.IdList | list of assignable map Ids | |
Errors | NULL_ARGUMENT | mapId is null | |
OPERATION_FAILED | unable to complete request | ||
Compliance | mandatory | This method must be implemented. | |
Method | getAssignableMapIdsForPath | ||
Description |
Gets a list of maps including and under the given map node in which a specific path can be assigned. | ||
Parameters | osid.id.Id | mapId | the Id of the Map |
osid.id.Id | pathId | the Id of the Path | |
Return | osid.id.IdList | list of assignable map Ids | |
Errors | NULL_ARGUMENT | mapId or pathId is null | |
OPERATION_FAILED | unable to complete request | ||
Compliance | mandatory | This method must be implemented. | |
Method | assignPathToMap | ||
Description |
Adds an existing | ||
Parameters | osid.id.Id | pathId | the Id of the Path |
osid.id.Id | mapId | the Id of the Map | |
Errors | ALREADY_EXISTS | pathId is already assigned to mapId | |
NOT_FOUND | pathId or mapId not found | ||
NULL_ARGUMENT | pathId or mapId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | unassignPathFromMap | ||
Description |
Removes a | ||
Parameters | osid.id.Id | pathId | the Id of the Path |
osid.id.Id | mapId | the Id of the Map | |
Errors | NOT_FOUND | pathId or mapId not found or pathId
not assigned to mapId | |
NULL_ARGUMENT | pathId or mapId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |