OSID - osid.mapping.LocationAdminSession Service Interface Definition

Interface	osid.mapping.LocationAdminSession
Implements	`osid.OsidSession`
Implemented By	`osid.mapping.batch.LocationBatchAdminSession`
Used By	`osid.mapping.MappingManager`
Used By	`osid.mapping.MappingProxyManager`
Description	This session creates, updates, and deletes `Locations`. The data for create and update is provided by the consumer via the form. `OsidForms` are requested for each create or update and may not be reused. Create and update operations differ in their usage. To create a `Location`, a `LocationForm` is requested using `getLocationFormForCreate()` specifying the desired record `Types` or none if no record `Types` are needed. The returned `LocationForm` 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 `LocationForm` is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each `LocationForm` corresponds to an attempted transaction. For updates, `LocationForms` are requested to the `Location` `Id` that is to be updated using `getLocationFormForUpdate()`. Similarly, the `LocationForm` has metadata about the data that can be updated and it can perform validation before submitting the update. The `LocationForm` can only be used once for a successful update and cannot be reused. The delete operations delete `Locations`. To unmap a `Location` from the current `Map`, the `LocationMapAssignmentSession` should be used. These delete operations attempt to remove the `Location` 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	canCreateLocations
Description	Tests if this user can create `Locations`. A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a `Location` 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 `Location` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreateLocationWithRecordTypes
Description	Tests if this user can create a single `Location` using the desired record types. While `MappingManager.getLocationRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `Location`. Providing an empty array tests if a `Location` can be created with no records.
Parameters	`osid.type.Type[]`	`locationRecordTypes`	array of location record types
Return	`boolean`		`true` if `Location` creation using the specified record `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`locationRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getLocationFormForCreate
Description	Gets the location form for creating new locations. A new form should be requested for each create transaction.
Parameters	`osid.type.Type[]`	`locationRecordTypes`	array of location record types
Return	`osid.mapping.LocationForm`		the location form
Errors	NULL_ARGUMENT		`locationRecordTypes` 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	createLocation
Description	Creates a new `Location`.
Parameters	`osid.mapping.LocationForm`	`locationForm`	the form for this `Location`
Return	`osid.mapping.Location`		the new `Location`
Errors	ILLEGAL_STATE		`locationForm` already used in a create transaction
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`locationForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`locationForm` did not originate from `getLocationFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdateLocations
Description	Tests if this user can update `Locations`. A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a `Location` 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 `Location` modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getLocationFormForUpdate
Description	Gets the location form for updating an existing location. A new location form should be requested for each update transaction.
Parameters	`osid.id.Id`	`locationId`	the `Id` of the `Location`
Return	`osid.mapping.LocationForm`		the location form
Errors	NOT_FOUND		`locationId` is not found
	NULL_ARGUMENT		`locationId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	updateLocation
Description	Updates an existing location.
Parameters	`osid.mapping.LocationForm`	`locationForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`locationForm` already used in an update transaction
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`locationId` or `locationForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`locationForm` did not originate from `getLocationFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeleteLocations
Description	Tests if this user can delete `Locations`. A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting a `Location` 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 `Location` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deleteLocation
Description	Deletes a `Location`.
Parameters	`osid.id.Id`	`locationId`	the `Id` of the `Location` to remove
Errors	NOT_FOUND		`locationId` not found
	NULL_ARGUMENT		`locationId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageLocationAliases
Description	Tests if this user can manage `Id` aliases for `Locations`. 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 `Location` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasLocation
Description	Adds an `Id` to a `Location` for the purpose of creating compatibility. The primary `Id` of the `Location` is determined by the provider. The new `Id` performs as an alias to the primary `Id`. If the alias is a pointer to another location, it is reassigned to the given location `Id`.
Parameters	`osid.id.Id`	`locationId`	the `Id` of a `Location`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is already assigned
	NOT_FOUND		`locationId` not found
	NULL_ARGUMENT		`locationId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.