OSID - osid.control.rules.TriggerEnablerAdminSession Service Interface Definition

Interface	osid.control.rules.TriggerEnablerAdminSession
Implements	`osid.OsidSession`
Used By	`osid.control.rules.ControlRulesManager`
Used By	`osid.control.rules.ControlRulesProxyManager`
Description	This session creates and removes trigger enablers. The data for create and update is provided via the `TriggerEnablerForm`.
Method	getSystemId
Description	Gets the `System` `Id` associated with this session.
Return	`osid.id.Id`		the `System Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getSystem
Description	Gets the `System` associated with this session.
Return	`osid.control.System`		the system
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canCreateTriggerEnabler
Description	Tests if this user can create trigger enablers. A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a `TriggerEnabler` 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 `TriggerEnabler` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreateTriggerEnablerWithRecordTypes
Description	Tests if this user can create a single `TriggerEnabler` using the desired record types. While `OfferingRulesManager.getTriggerEnablerRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `TriggerEnabler`. Providing an empty array tests if a `TriggerEnabler` can be created with no records.
Parameters	`osid.type.Type[]`	`triggerEnablerRecordTypes`	array of trigger enabler record types
Return	`boolean`		`true` if `TriggerEnabler` creation using the specified record `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`triggerEnablerRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getTriggerEnablerFormForCreate
Description	Gets the trigger enabler form for creating new trigger enablers. A new form should be requested for each create transaction.
Parameters	`osid.type.Type[]`	`triggerEnablerRecordTypes`	array of trigger enabler record types
Return	`osid.control.rules.TriggerEnablerForm`		the trigger enabler form
Errors	NULL_ARGUMENT		`triggerEnablerRecordTypes` 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	createTriggerEnabler
Description	Creates a new `TriggerEnabler`.
Parameters	`osid.control.rules.TriggerEnablerForm`	`triggerEnablerForm`	the form for this `TriggerEnabler`
Return	`osid.control.rules.TriggerEnabler`		the new `TriggerEnabler`
Errors	ILLEGAL_STATE		`triggerEnablerForm` already used in a create transaction
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`triggerEnablerForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`triggerEnablerForm did not originate from getTriggerEnablerFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdateTriggerEnablers
Description	Tests if this user can update trigger enablers. A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a `TriggerEnabler` 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 `TriggerEnabler` modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getTriggerEnablerFormForUpdate
Description	Gets the trigger enabler form for updating an existing trigger enabler. A new trigger enabler form should be requested for each update transaction.
Parameters	`osid.id.Id`	`triggerEnablerId`	the `Id` of the `TriggerEnabler`
Return	`osid.control.rules.TriggerEnablerForm`		the trigger enabler form
Errors	NOT_FOUND		`triggerEnablerId` is not found
	NULL_ARGUMENT		`triggerEnablerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	updateTriggerEnabler
Description	Updates an existing trigger enabler.
Parameters	`osid.control.rules.TriggerEnablerForm`	`triggerEnablerForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`triggerEnablerForm` already used in an update transaction
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`triggerEnablerForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`triggerEnablerForm` did not originate from `getTriggerEnablerFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeleteTriggerEnablers
Description	Tests if this user can delete trigger enablers. A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting a `TriggerEnabler` 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 `TriggerEnabler` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deleteTriggerEnabler
Description	Deletes a `TriggerEnabler`.
Parameters	`osid.id.Id`	`triggerEnablerId`	the `Id` of the `TriggerEnabler` to remove
Errors	NOT_FOUND		`triggerEnablerId` not found
	NULL_ARGUMENT		`triggerEnablerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageTriggerEnablerAliases
Description	Tests if this user can manage `Id` aliases for trigger 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 `TriggerEnabler` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasTriggerEnabler
Description	Adds an `Id` to a `TriggerEnabler` for the purpose of creating compatibility. The primary `Id` of the `TriggerEnabler` is determined by the provider. The new `Id` performs as an alias to the primary `Id`. If the alias is a pointer to another trigger enabler. it is reassigned to the given trigger enabler `Id`.
Parameters	`osid.id.Id`	`triggerEnablerId`	the `Id` of a `TriggerEnabler`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is already assigned
	NOT_FOUND		`triggerEnablerId` not found
	NULL_ARGUMENT		`triggerEnablerId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.