OSID - osid.mapping.path.IntersectionAdminSession Service Interface Definition

Interface	osid.mapping.path.IntersectionAdminSession
Implements	`osid.OsidSession`
Implemented By	`osid.mapping.path.batch.IntersectionBatchAdminSession`
Used By	`osid.mapping.path.MappingPathManager`
Used By	`osid.mapping.path.MappingPathProxyManager`
Description	This session creates, updates, and deletes `Intersections`. 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 an `Intersection`, an `IntersectionForm` is requested using `getIntersectionFormForCreate()` specifying the desired paths and record `Types` or none if no record `Types` are needed. The returned `IntersectionForm` 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 `IntersectionForm` is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each `IntersectionForm` corresponds to an attempted transaction. For updates, `IntersectionForms` are requested to the `Intersection` `Id` that is to be updated using `getIntersectionFormForUpdate()`. Similarly, the `IntersectionForm` has metadata about the data that can be updated and it can perform validation before submitting the update. The `IntersectionForm` can only be used once for a successful update and cannot be reused. The delete operations delete `Intersections`. To unmap an `Intersection` from the current `Map`, the `IntersectionMapAssignmentSession` should be used. These delete operations attempt to remove the `Intersection` 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	canCreateIntersections
Description	Tests if this user can create `Intersections`. A return of true does not guarantee successful authorization. A return of false indicates that it is known creating an `Intersection` will result in a `PERMISSION_DENIED`. This is intended as a hint to an application that may opt not to offer create operations to unauthorized users.
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 `Intersection` using the desired record types. While `MappingPathManager.getIntersectionRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `Intersection`. Providing an empty array tests if an `Intersection` can be created with no records.
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
Parameters	`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 `Intersection`.
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 `Intersections`. A return of true does not guarantee successful authorization. A return of false indicates that it is known updating an `Intersection` 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 `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 `Intersection`. A return of true does not guarantee successful authorization. A return of false indicates that it is known updating the `Intersection` will result in a `PERMISSION_DENIED`. This is intended as a hint to an application that may opt not to offer an update operation to an unauthorized user for this intersection.
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 `intersectionId` is not found, then it is acceptable to return false to indicate the lack of an update available.
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`
Parameters	`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 `Intersections`. A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting an `Intersection` will result in a `PERMISSION_DENIED`. This is intended as a hint to an application that may opt not to offer delete operations to unauthorized users.
Return	`boolean`		`false` if `Intersection` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deleteIntersection
Description	Deletes an `Intersection`.
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`
Parameters	`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 `Id` aliases for `Intersections`. 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 `Intersection` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasIntersection
Description	Adds an `Id` to an `Intersection` for the purpose of creating compatibility. The primary `Id` of the `Intersection` is determined by the provider. The new `Id` performs as an alias to the primary `Id`.
Parameters	`osid.id.Id`	`intersectionId`	the `Id` of an `Intersection`
Parameters	`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.