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

Interface	osid.mapping.path.SignalAdminSession
Implements	`osid.OsidSession`
Description	This session creates, updates, and deletes `Signals.` 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 a `Signal,` a `SignalForm` is requested using `getSignalFormForCreate()` specifying the desired record `Types` or none if no record `Types` are needed. The returned `SignalForm` 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 `SignalForm` is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each `SignalForm` corresponds to an attempted transaction. For updates, `SignalForms` are requested to the `Signal` `Id` that is to be updated using `getSignalFormForUpdate().` Similarly, the `SignalForm` has metadata about the data that can be updated and it can perform validation before submitting the update. The `SignalForm` can only be used once for a successful update and cannot be reused. The delete operations delete `Signals.` To unmap a `Signal` from the current `Map,` the `SignalMapAssignmentSession` should be used. These delete operations attempt to remove the `Signal` 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	canCreateSignals
Description	Tests if this user can create `Signals.` A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a `Signal` 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 `Signal` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreateSignalWithRecordTypes
Description	Tests if this user can create a single `Signal` using the desired record types. While `MappingPathManager.getSignalRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `Signal.` Providing an empty array tests if a `Signal` can be created with no records.
Parameters	`osid.type.Type[]`	`signalRecordTypes`	array of signal record types
Return	`boolean`		`true` if `Signal` creation using the specified record `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`signalRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getSignalFormForCreate
Description	Gets the signal form for creating new signals. A new form should be requested for each create transaction.
Parameters	`osid.id.Id`	`pathId`	`Id` of the path
Parameters	`osid.type.Type[]`	`signalRecordTypes`	array of signal record types
Return	`osid.mapping.path.SignalForm`		the signal form
Errors	NOT_FOUND		`pathId` is not found
	NULL_ARGUMENT		`pathId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		unable to get form with given record types
Compliance	`mandatory`		This method must be implemented.
Method	createSignal
Description	Creates a new `Signal.`
Parameters	`osid.mapping.path.SignalForm`	`signalForm`	the form for this `Signal`
Return	`osid.mapping.path.Signal`		the new `Signal`
Errors	ILLEGAL_STATE		`signalForm` already used in a create transaction
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`signalForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`signalForm` did not originate from `getSignalFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdateSignals
Description	Tests if this user can update `Signals.` A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a `Signal` 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 `Signal` modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getSignalFormForUpdate
Description	Gets the signal form for updating an existing signal. A new signal form should be requested for each update transaction.
Parameters	`osid.id.Id`	`signalId`	the `Id` of the `Signal`
Return	`osid.mapping.path.SignalForm`		the signal form
Errors	NOT_FOUND		`signalId` is not found
	NULL_ARGUMENT		`signalId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	updateSignal
Description	Updates an existing signal.
Parameters	`osid.mapping.path.SignalForm`	`signalForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`signalForm` already used in an update transaction
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`signalId` or `signalForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`signalForm` did not originate from `getSignalFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeleteSignals
Description	Tests if this user can delete `Signals.` A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting a `Signal` 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 `Signal` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deleteSignal
Description	Deletes a `Signal.`
Parameters	`osid.id.Id`	`signalId`	the `Id` of the `Signal` to remove
Errors	NOT_FOUND		`signalId` not found
	NULL_ARGUMENT		`signalId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageSignalAliases
Description	Tests if this user can manage `Id` aliases for `Signals.` 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 `Signal` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasSignal
Description	Adds an `Id` to a `Signal` for the purpose of creating compatibility. The primary `Id` of the `Signal` 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, it is reassigned to the given signal `Id.`
Parameters	`osid.id.Id`	`signalId`	the `Id` of a `Signal`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is already assigned
	NOT_FOUND		`signalId` not found
	NULL_ARGUMENT		`signalId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.