OSID - osid.rules.RuleAdminSession Service Interface Definition

Interface	osid.rules.RuleAdminSession
Implements	`osid.OsidSession`
Description	This session creates, updates, and deletes `Rules.` 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 `Rule,` a `RuleForm` is requested using `getRuleFormForCreate()` specifying the desired record `Types` or none if no record `Types` are needed. The returned `RuleForm` 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 `RuleForm` is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each `RuleForm` corresponds to an attempted transaction. For updates, `RuleForms` are requested to the `Rule` `Id` that is to be updated using `getRuleFormForUpdate().` Similarly, the `RuleForm` has metadata about the data that can be updated and it can perform validation before submitting the update. The `RuleForm` can only be used once for a successful update and cannot be reused. The delete operations delete `Rules.` To unmap a `Rule` from the current `Engine,` the `RuleEngineAssignmentSession` should be used. These delete operations attempt to remove the `Rule` itself thus removing it from all known `Engine` catalogs. This session includes an `Id` aliasing mechanism to assign an external `Id` to an internally assigned Id.
Method	getEngineId
Description	Gets the `Engine` `Id` associated with this session.
Return	`osid.id.Id`		the `Engine Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getEngine
Description	Gets the `Engine` associated with this session.
Return	`osid.rules.Engine`		the `Engine` associated with this session
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canCreateRules
Description	Tests if this user can create `Rules.` A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a `Rule` 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 `Rule` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreateRuleWithRecordTypes
Description	Tests if this user can create a single `Rule` using the desired record types. While `RulesManager.getRuleRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `Rule.` Providing an empty array tests if a `Rule` can be created with no records.
Parameters	`osid.type.Type[]`	`ruleRecordTypes`	array of rule record types
Return	`boolean`		`true` if `Rule` creation using the specified record `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`ruleRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getRuleFormForCreate
Description	Gets the rule form for creating new rules. A new form should be requested for each create transaction.
Parameters	`osid.type.Type[]`	`ruleRecordTypes`	array of rule record types
Return	`osid.rules.RuleForm`		the rule form
Errors	NULL_ARGUMENT		`ruleRecordTypes` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		unable to get form with requested record types
Compliance	`mandatory`		This method must be implemented.
Method	createRule
Description	Creates a new `Rule.`
Parameters	`osid.rules.RuleForm`	`ruleForm`	the form for this `Rule`
Return	`osid.rules.Rule`		the new `Rule`
Errors	ILLEGAL_STATE		`ruleForm` already used in a create transaction
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`ruleForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`ruleForm` did not originate from `getRuleFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdateRules
Description	Tests if this user can update `Rules.` A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a `Rule` 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 rule modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getRuleFormForUpdate
Description	Gets the rule form for updating an existing rule. A new rule form should be requested for each update transaction.
Parameters	`osid.id.Id`	`ruleId`	the `Id` of the `Rule`
Return	`osid.rules.RuleForm`		the rule form
Errors	NOT_FOUND		`ruleId` is not found
	NULL_ARGUMENT		`ruleId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	updateRule
Description	Updates an existing rule.
Parameters	`osid.rules.RuleForm`	`ruleForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`ruleForm` already used in an update transaction
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`ruleForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`ruleForm` did not originate from `getRuleFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeleteRules
Description	Tests if this user can delete `Rules.` A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting a `Rule` 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 `Rule` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deleteRule
Description	Deletes the `Rule` identified by the given `Id.`
Parameters	`osid.id.Id`	`ruleId`	the `Id` of the `Rule` to delete
Errors	NOT_FOUND		a `Rule` was not found identified by the given `Id`
	NULL_ARGUMENT		`ruleId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageRuleAliases
Description	Tests if this user can manage `Id` aliases for `Rules.` 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 `Rule` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasRule
Description	Adds an `Id` to a `Rule` for the purpose of creating compatibility. The primary `Id` of the `Rule` is determined by the provider. The new `Id` performs as an alias to the primary `Id.` If the alias is a pointer to another rule, it is reassigned to the given rule `Id.`
Parameters	`osid.id.Id`	`ruleId`	the `Id` of a `Rule`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is already assigned
	NOT_FOUND		`ruleId` not found
	NULL_ARGUMENT		`ruleId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.