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

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