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

Interface	osid.mapping.path.rules.ObstacleEnablerAdminSession
Implements	`osid.OsidSession`
Used By	`osid.mapping.path.rules.MappingPathRulesManager`
Used By	`osid.mapping.path.rules.MappingPathRulesProxyManager`
Description	This session creates and removes obstacle enablers. The data for create and update is provided via the `ObstacleEnablerForm`.
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	canCreateObstacleEnabler
Description	Tests if this user can create obstacle enablers. A return of true does not guarantee successful authorization. A return of false indicates that it is known creating an `ObstacleEnabler` 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 `ObstacleEnabler` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreateObstacleEnablerWithRecordTypes
Description	Tests if this user can create a single `ObstacleEnabler` using the desired record types. While `MappingPathRulesManager.getObstacleEnablerRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `ObstacleEnabler`. Providing an empty array tests if an `ObstacleEnabler` can be created with no records.
Parameters	`osid.type.Type[]`	`obstacleEnablerRecordTypes`	array of obstacle enabler record types
Return	`boolean`		`true` if `ObstacleEnabler` creation using the specified record `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`obstacleEnablerRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getObstacleEnablerFormForCreate
Description	Gets the obstacle enabler form for creating new obstacle enablers. A new form should be requested for each create transaction.
Parameters	`osid.type.Type[]`	`obstacleEnablerRecordTypes`	array of obstacle enabler record types
Return	`osid.mapping.path.rules.ObstacleEnablerForm`		the obstacle enabler form
Errors	NULL_ARGUMENT		`obstacleEnablerRecordTypes` 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	createObstacleEnabler
Description	Creates a new `ObstacleEnabler`.
Parameters	`osid.mapping.path.rules.ObstacleEnablerForm`	`obstacleEnablerForm`	the form for this `ObstacleEnabler`
Return	`osid.mapping.path.rules.ObstacleEnabler`		the new `ObstacleEnabler`
Errors	ILLEGAL_STATE		`obstacleEnablerForm` already used in a create transaction
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`obstacleEnablerForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`obstacleEnablerForm` did not originate from `getObstacleEnablerFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdateObstacleEnablers
Description	Tests if this user can update obstacle enablers. A return of true does not guarantee successful authorization. A return of false indicates that it is known updating an `ObstacleEnabler` 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 `ObstacleEnabler` modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getObstacleEnablerFormForUpdate
Description	Gets the obstacle enabler form for updating an existing obstacle enabler. A new obstacle enabler form should be requested for each update transaction.
Parameters	`osid.id.Id`	`obstacleEnablerId`	the `Id` of the `ObstacleEnabler`
Return	`osid.mapping.path.rules.ObstacleEnablerForm`		the obstacle enabler form
Errors	NOT_FOUND		`obstacleEnablerId` is not found
	NULL_ARGUMENT		`obstacleEnablerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	updateObstacleEnabler
Description	Updates an existing obstacle enabler.
Parameters	`osid.mapping.path.rules.ObstacleEnablerForm`	`obstacleEnablerForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`obstacleEnablerForm` already used in an update transaction
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`obstacleEnablerForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`obstacleEnablerForm` did not originate from `getObstacleEnablerFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeleteObstacleEnablers
Description	Tests if this user can delete obstacle enablers. A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting an `ObstacleEnabler` 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 `ObstacleEnabler` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deleteObstacleEnabler
Description	Deletes an `ObstacleEnabler`.
Parameters	`osid.id.Id`	`obstacleEnablerId`	the `Id` of the `ObstacleEnabler` to remove
Errors	NOT_FOUND		`obstacleEnablerId` not found
	NULL_ARGUMENT		`obstacleEnablerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageObstacleEnablerAliases
Description	Tests if this user can manage `Id` aliases for obstacle 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 `ObstacleEnabler` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasObstacleEnabler
Description	Adds an `Id` to an `ObstacleEnabler` for the purpose of creating compatibility. The primary `Id` of the `ObstacleEnabler` is determined by the provider. The new `Id` performs as an alias to the primary `Id`. If the alias is a pointer to another obstacle enabler. it is reassigned to the given obstacle enabler `Id`.
Parameters	`osid.id.Id`	`obstacleEnablerId`	the `Id` of an `ObstacleEnabler`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is already assigned
	NOT_FOUND		`obstacleEnablerId` not found
	NULL_ARGUMENT		`obstacleEnablerId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.