OSID - osid.mapping.route.RouteAdminSession Service Interface Definition

Interface	osid.mapping.route.RouteAdminSession
Implements	`osid.OsidSession`
Used By	`osid.mapping.route.MappingRouteManager`
Used By	`osid.mapping.route.MappingRouteProxyManager`
Description	This session creates, updates, and deletes `Routes`. The data for create and update is provided by the consumer via the form object. `OsidForms` are requested for each create or update and may not be reused. Create and update operations differ in their usage. To create a `Route`, a `RouteForm` is requested using `getRouteFormForCreate()` specifying the desired record `Types` or none if no record `Types` are needed. The returned `RouteForm` will indicate that it is to be used with a create operation and can be used to examine metdata or validate data prior to creation. Once the `RouteForm` is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each `RouteForm` corresponds to an attempted transaction. For updates, `RouteForms` are requested to the `Route` `Id` that is to be updated using `getRouteFormForUpdate()`. Similarly, the `RouteForm` has metadata about the data that can be updated and it can perform validation before submitting the update. The `RouteForm` can only be used once for a successful update and cannot be reused. The delete operations delete `Routes`. To unmap a `Route` from the current `Map`, the `RouteMapAssignmentSession` should be used. These delete operations attempt to remove the `Route` itself thus removing it from all known `Map` catalogs. This session includes an `Id` aliasing mechanism to assign an external `Id` to an internally assigned Id.
Method	getMapId
Description	Gets the `Map` `Id` associated with this session.
Return	`osid.id.Id`		the `Map Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getMap
Description	Gets the `Map` associated with this session.
Return	`osid.mapping.Map`		the map
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canCreateRoutes
Description	Tests if this user can create `Routes`. A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a `Route` will result in a `PERMISSION_DENIED`. This is intended as a hint to an application that may opt not to offer create operations to an unauthorized user.
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 `Route` using the desired record types. While `MappingRouteManager.getRouteRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `Route`. Providing an empty array tests if a `Route` can be created with no records.
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 `Route`.
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 `Routes`. A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a `Route` will result in a `PERMISSION_DENIED`. This is intended as a hint to an application that may opt not to offer update operations to an unauthorized user.
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 `Routes`. A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting a `Route` will result in a `PERMISSION_DENIED`. This is intended as a hint to an application that may opt not to offer delete operations to an unauthorized user.
Return	`boolean`		`false` if `Route` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deleteRoute
Description	Deletes a `Route`.
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 `Id` aliases for `Routes`. A return of true does not guarantee successful authorization. A return of false indicates that it is known changing an alias will result in a `PERMISSION_DENIED`. This is intended as a hint to an application that may opt not to offer alias operations to an unauthorized user.
Return	`boolean`		`false` if `Route` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasRoute
Description	Adds an `Id` to a `Route` for the purpose of creating compatibility. The primary `Id` of the `Route` is determined by the provider. The new `Id` performs as an alias to the primary `Id`.The new `Id` performs as an alias to the primary `Id`. If the alias is a pointer to another route, it is reassigned to the given route `Id`.
Parameters	`osid.id.Id`	`routeId`	the `Id` of a `Route`
Parameters	`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 `RouteSegment` using the desired record types. While `MappingRouteManager.getRouteSegmentRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `Route`. Providing an empty array tests if a `Route` can be created with no records.
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`
Parameters	`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 `RouteSegment`.
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 `RouteSegment`.
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 `RouteSegment`.
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 `Id` aliases for `RouteSegments`. A return of true does not guarantee successful authorization. A return of false indicates that it is known changing an alias will result in a `PERMISSION_DENIED`. This is intended as a hint to an application that may opt not to offer alias operations to an unauthorized user.
Return	`boolean`		`false` if `RouteSegment` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasRouteSegment
Description	Adds an `Id` to a `RouteSegment` for the purpose of creating compatibility. The primary `Id` of the `RouteSegment` is determined by the provider. The new `Id` performs as an alias to the primary `Id`. If the alias is a pointer to another route segment, it is reassigned to the given route segment `Id`.
Parameters	`osid.id.Id`	`routeSegmentId`	the `Id` of a `RouteSegment`
Parameters	`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.