Interface | osid.mapping.path.IntersectionAdminSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session creates, updates, and deletes Create and update operations differ in their usage. To
create an 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 | canCreateIntersections | ||
Description |
Tests if this user can create | ||
Return | boolean | false if Intersection creation is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | canCreateIntersectionWithRecordTypes | ||
Description |
Tests if this user can create a single | ||
Parameters | osid.type.Type[] | intersectionRecordTypes | array of intersection record types |
Return | boolean | true if Intersection creation using the
specified record Types is supported, false
otherwise | |
Errors | NULL_ARGUMENT | intersectionRecordTypes is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getIntersectionFormForCreate | ||
Description |
Gets the intersection form for creating new intersections. A new form should be requested for each create transaction. | ||
Parameters | osid.id.Id[] | pathIds | the Id of the paths |
osid.type.Type[] | intersectionRecordTypes | array of intersection record types | |
Return | osid.mapping.path.IntersectionForm | the intersection form | |
Errors | NOT_FOUND | a pathId is not found | |
NULL_ARGUMENT | pathIds or intersectionRecordTypes 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 | createIntersection | ||
Description |
Creates a new | ||
Parameters | osid.mapping.path.IntersectionForm | intersectionForm | an intersection form |
Return | osid.mapping.path.Intersection | the new Intersection | |
Errors | ILLEGAL_STATE | intersectionForm already used in a create transaction | |
INVALID_ARGUMENT | the form contains an invalid value | ||
NULL_ARGUMENT | pathIds or intersectionForm is null
| ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | intersectionForm did not originate from
getIntersectionFormForCreate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | canUpdateIntersections | ||
Description |
Tests if this user can update | ||
Return | boolean | false if Intersection modification is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | canUpdateIntersection | ||
Description |
Tests if this user can update a specified | ||
Parameters | osid.id.Id | intersectionId | the Id of the Intersection |
Return | boolean | false if intersection modification is not authorized,
true otherwise | |
Errors | NULL_ARGUMENT | intersectionId is null | |
Compliance | mandatory | This method must be implemented. | |
Provider Notes |
If the | ||
Method | getIntersectionFormForUpdate | ||
Description |
Gets the intersection form for updating an existing intersection. A new intersection form should be requested for each update transaction. | ||
Parameters | osid.id.Id | intersectionId | the Id of the Intersection |
Return | osid.mapping.path.IntersectionForm | the intersection form | |
Errors | NOT_FOUND | intersectionId is not found | |
NULL_ARGUMENT | intersectionId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | updateIntersection | ||
Description |
Updates an existing intersection. | ||
Parameters | osid.mapping.path.IntersectionForm | intersectionForm | the form containing the elements to be updated |
Errors | ILLEGAL_STATE | intersectionForm already used in an update transaction | |
INVALID_ARGUMENT | the form contains an invalid value | ||
NULL_ARGUMENT | intersectionForm is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
UNSUPPORTED | intersectionForm did not originate from
getIntersectionFormForUpdate() | ||
Compliance | mandatory | This method must be implemented. | |
Method | addPathToIntersection | ||
Description |
Adds a path to an existing intersection. | ||
Parameters | osid.id.Id | intersectionId | the Id of the Intersection |
osid.id.Id | pathId | the Id of the a Path | |
Errors | NOT_FOUND | intersectionId or pathId is not found | |
NULL_ARGUMENT | intersectionId or pathId is null
| ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canDeleteIntersections | ||
Description |
Tests if this user can delete | ||
Return | boolean | false if Intersection deletion is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | deleteIntersection | ||
Description |
Deletes an | ||
Parameters | osid.id.Id | intersectionId | the Id of the Intersection to remove |
Errors | NOT_FOUND | intersectionId not found | |
NULL_ARGUMENT | intersectionId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | removePathFromIntersection | ||
Description |
Removes a path from an existing intersection. | ||
Parameters | osid.id.Id | intersectionId | the Id of the Intersection |
osid.id.Id | pathId | the Id of the Path to remove | |
Errors | NOT_FOUND | intersectionId or pathId not found | |
NULL_ARGUMENT | intersectionId or pathId is null
| ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canManageIntersectionAliases | ||
Description |
Tests if this user can manage | ||
Return | boolean | false if Intersection aliasing is not
authorized, true otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | aliasIntersection | ||
Description |
Adds an | ||
Parameters | osid.id.Id | intersectionId | the Id of an Intersection |
osid.id.Id | aliasId | the alias Id | |
Errors | ALREADY_EXISTS | aliasId is already assigned | |
NOT_FOUND | intersectionId not found | ||
NULL_ARGUMENT | intersectionId or aliasId is null
| ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |