Interface | osid.mapping.route.RouteAdminSession | ||
---|---|---|---|
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 | canCreateRoutes | ||
Description |
Tests if this user can create | ||
Return | boolean | false if Route creation is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | canCreateRouteWithRecordTypes | ||
Description |
Tests if this user can create a single | ||
Parameters | osid.type.Type[] | routeRecordTypes | array of route record types |
Return | boolean | true if Route creation using the specified
record Types is supported, false otherwise | |
Errors | NULL_ARGUMENT | routeRecordTypes is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getRouteFormForCreate | ||
Description |
Gets the route form for creating new routes. A new form should be requested for each create transaction. | ||
Parameters | osid.id.Id | startingLocationId | the Id of the starting location. |
osid.id.Id | endingLocationId | the Id of the ending location. | |
osid.type.Type[] | routeRecordTypes | array of route record types | |
Return | osid.mapping.route.RouteForm | the route form | |
Errors | NOT_FOUND | startingLocationId or endingLocationId is not
found | |
NULL_ARGUMENT | startingLocationId, endingLocationId or
routeRecordTypes is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | unable top get form with given record types | ||
Compliance | mandatory | This method must be implemented. | |
Method | createRoute | ||
Description |
Creates a new | ||
Parameters | osid.mapping.route.RouteForm | routeForm | the form for this Route |
Return | osid.mapping.route.Route | the new Route | |
Errors | ILLEGAL_STATE | routeForm already used in a create transaction | |
INVALID_ARGUMENT | one or more of the form elements is invalid | ||
NULL_ARGUMENT | routeForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | routeForm did not originate from
getRouteFormForCreate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canUpdateRoutes | ||
Description |
Tests if this user can update | ||
Return | boolean | false if Route modification is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | getRouteFormForUpdate | ||
Description |
Gets the route form for updating an existing route. A new route form should be requested for each update transaction. | ||
Parameters | osid.id.Id | routeId | the Id of the Route |
Return | osid.mapping.route.RouteForm | the route form | |
Errors | NOT_FOUND | routeId is not found | |
NULL_ARGUMENT | routeId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateRoute | ||
Description |
Updates an existing route. | ||
Parameters | osid.mapping.route.RouteForm | routeForm | the form containing the elements to be updated |
Errors | ILLEGAL_STATE | routeForm already used in an update transaction | |
INVALID_ARGUMENT | the form contains an invalid value | ||
NULL_ARGUMENT | routeForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | routeForm did not originate from
getRouteFormForUpdate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canDeleteRoutes | ||
Description |
Tests if this user can delete | ||
Return | boolean | false if Route deletion is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | deleteRoute | ||
Description |
Deletes a | ||
Parameters | osid.id.Id | routeId | the Id of the Route to remove |
Errors | NOT_FOUND | routeId not found | |
NULL_ARGUMENT | routeId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canManageRouteAliases | ||
Description |
Tests if this user can manage | ||
Return | boolean | false if Route aliasing is not authorized,
true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | aliasRoute | ||
Description |
Adds an | ||
Parameters | osid.id.Id | routeId | the Id of a Route |
osid.id.Id | aliasId | the alias Id | |
Errors | ALREADY_EXISTS | aliasId is already assigned | |
NOT_FOUND | routeId not found | ||
NULL_ARGUMENT | routeId or aliasId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canCreateRouteSegmentWithRecordTypes | ||
Description |
Tests if this user can create a single | ||
Parameters | osid.type.Type[] | routeSegmentRecordTypes | array of route segment record types |
Return | boolean | true if RouteSegment creation using the
specified record Types is supported, false
otherwise | |
Errors | NULL_ARGUMENT | routeSegmentRecordTypes is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getRouteSegmentFormForCreate | ||
Description |
Gets the route segment form for adding route segments. A new form should be requested for each create transaction. | ||
Parameters | osid.id.Id | routeId | the Id of a Route |
osid.type.Type[] | routeSegmentRecordTypes | array of route segment record types | |
Return | osid.mapping.route.RouteSegmentForm | the route segment form | |
Errors | NOT_FOUND | routeId is not found | |
NULL_ARGUMENT | routeId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | unable to get form with given record types | ||
Compliance | mandatory | This method must be implemented. | |
Method | createRouteSegment | ||
Description |
Creates a new | ||
Parameters | osid.mapping.route.RouteSegmentForm | routeSegmentForm | the form for this RouteSegment |
Return | osid.mapping.route.RouteSegment | the new RouteSegment | |
Errors | ILLEGAL_STATE | routeSegmentForm already used in a create transaction | |
INVALID_ARGUMENT | one or more of the form elements is invalid | ||
NULL_ARGUMENT | routeForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | routeForm did not originate from
getRouteSegmentFormForCreate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | getRouteSegmentFormForUpdate | ||
Description |
Gets the route segment form for adding route segments. A new form should be requested for each create transaction. | ||
Parameters | osid.id.Id | routeSegmentId | the Id of the RouteSegment |
Return | osid.mapping.route.RouteSegmentForm | the route segment form | |
Errors | NOT_FOUND | routeSegmentId is not found | |
NULL_ARGUMENT | routeSegmentId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateRouteSegment | ||
Description |
Updates a | ||
Parameters | osid.mapping.route.RouteSegmentForm | routeSegmentForm | the form for this RouteSegment |
Errors | ILLEGAL_STATE | routeSegmentForm already used in an update transaction | |
INVALID_ARGUMENT | one or more of the form elements is invalid | ||
NULL_ARGUMENT | routeForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | routeForm did not originate from
getRouteSegmentFormForUpdate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | deleteRouteSegment | ||
Description |
Deletes a | ||
Parameters | osid.id.Id | routeSegmentId | the Id of the route segment to delete |
Errors | NOT_FOUND | routeSegmentId is not found | |
NULL_ARGUMENT | routeSegmentId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canManageRouteSegmentAliases | ||
Description |
Tests if this user can manage | ||
Return | boolean | false if RouteSegment aliasing is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | aliasRouteSegment | ||
Description |
Adds an | ||
Parameters | osid.id.Id | routeSegmentId | the Id of a RouteSegment |
osid.id.Id | aliasId | the alias Id | |
Errors | ALREADY_EXISTS | aliasId is already assigned | |
NOT_FOUND | routeSegmentId not found | ||
NULL_ARGUMENT | routeSegmentId or aliasId is null
| ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |