OSID - osid.mapping.path.rules.SpeedZoneEnablerAdminSession Service Interface Definition

Interface	osid.mapping.path.rules.SpeedZoneEnablerAdminSession
Implements	`osid.OsidSession`
Description	This session creates and removes speed zone enablers. The data for create and update is provided via the `SpeedZoneEnablerForm.`
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	canCreateSpeedZoneEnabler
Description	Tests if this user can create speed zone enablers. A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a `SpeedZoneEnabler` 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 `SpeedZoneEnabler` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreateSpeedZoneEnablerWithRecordTypes
Description	Tests if this user can create a single `SpeedZoneEnabler` using the desired record types. While `MappingPathRulesManager.getSpeedZoneEnablerRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `SpeedZoneEnabler.` Providing an empty array tests if a `SpeedZoneEnabler` can be created with no records.
Parameters	`osid.type.Type[]`	`speedZoneEnablerRecordTypes`	array of speed zone enabler record types
Return	`boolean`		`true` if `SpeedZoneEnabler` creation using the specified record `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`speedZoneEnablerRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getSpeedZoneEnablerFormForCreate
Description	Gets the speed zone enabler form for creating new speed zone enablers. A new form should be requested for each create transaction.
Parameters	`osid.type.Type[]`	`speedZoneEnablerRecordTypes`	array of speed zone enabler record types
Return	`osid.mapping.path.rules.SpeedZoneEnablerForm`		the speed zone enabler form
Errors	NULL_ARGUMENT		`speedZoneEnablerRecordTypes` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		unable to get form for requested record types
Compliance	`mandatory`		This method must be implemented.
Method	createSpeedZoneEnabler
Description	Creates a new `SpeedZoneEnabler.`
Parameters	`osid.mapping.path.rules.SpeedZoneEnablerForm`	`speedZoneEnablerForm`	the form for this `SpeedZoneEnabler`
Return	`osid.mapping.path.rules.SpeedZoneEnabler`		the new `SpeedZoneEnabler`
Errors	ILLEGAL_STATE		`speedZoneEnablerForm` already used in a create transaction
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`speedZoneEnablerForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`speedZoneEnablerForm` did not originate from `getSpeedZoneEnablerFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdateSpeedZoneEnablers
Description	Tests if this user can update speed zone enablers. A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a `SpeedZoneEnabler` 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 `SpeedZoneEnabler` modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getSpeedZoneEnablerFormForUpdate
Description	Gets the speed zone enabler form for updating an existing speed zone enabler. A new speed zone enabler form should be requested for each update transaction.
Parameters	`osid.id.Id`	`speedZoneEnablerId`	the `Id` of the `SpeedZoneEnabler`
Return	`osid.mapping.path.rules.SpeedZoneEnablerForm`		the speed zone enabler form
Errors	NOT_FOUND		`speedZoneEnablerId` is not found
	NULL_ARGUMENT		`speedZoneEnablerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	updateSpeedZoneEnabler
Description	Updates an existing speed zone enabler.
Parameters	`osid.mapping.path.rules.SpeedZoneEnablerForm`	`speedZoneEnablerForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`speedZoneEnablerForm` already used in an update transaction
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`speedZoneEnablerForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`speedZoneEnablerForm` did not originate from `getSpeedZoneEnablerFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeleteSpeedZoneEnablers
Description	Tests if this user can delete speed zone enablers. A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting a `SpeedZoneEnabler` 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 `SpeedZoneEnabler` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deleteSpeedZoneEnabler
Description	Deletes a `SpeedZoneEnabler.`
Parameters	`osid.id.Id`	`speedZoneEnablerId`	the `Id` of the `SpeedZoneEnabler` to remove
Errors	NOT_FOUND		`speedZoneEnablerId` not found
	NULL_ARGUMENT		`speedZoneEnablerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageSpeedZoneEnablerAliases
Description	Tests if this user can manage `Id` aliases for speed zone enablers. 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 `SpeedZoneEnabler` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasSpeedZoneEnabler
Description	Adds a `Id` to a `SpeedZoneEnabler` for the purpose of creating compatibility. The primary `Id` of the `SpeedZoneEnabler` is determined by the provider. The new `Id` performs as an alias to the primary `Id` . If the alias is a pointer to another speed zone enabler. it is reassigned to the given speed zone enabler `Id.`
Parameters	`osid.id.Id`	`speedZoneEnablerId`	the `Id` of a `SpeedZoneEnabler`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is already assigned
	NOT_FOUND		`speedZoneEnablerId` not found
	NULL_ARGUMENT		`speedZoneEnablerId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.