OSID - osid.rules.check.CheckAdminSession Service Interface Definition

Interface	osid.rules.check.CheckAdminSession
Implements	`osid.OsidSession`
Description	This session creates, updates, and deletes `Checks.` 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 `Check,` a `CheckForm` is requested using `getCheckFormForCreate()` specifying the desired record `Types` or none if no record `Types` are needed. The returned `CheckForm` 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 `CheckForm` is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each `CheckForm` corresponds to an attempted transaction. For updates, `CheckForms` are requested to the `Check` `Id` that is to be updated using `getCheckFormForUpdate().` Similarly, the `CheckForm` has metadata about the data that can be updated and it can perform validation before submitting the update. The `CheckForm` can only be used once for a successful update and cannot be reused. The delete operations delete `Checks.` To unmap a `Check` from the current `Engine,` the `CheckEngineAssignmentSession` should be used. These delete operations attempt to remove the `Check` 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
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canCreateChecks
Description	Tests if this user can create `Checks.` A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a `Check` 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 `Check` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreateCheckWithRecordTypes
Description	Tests if this user can create a single `Check` using the desired record types. While `RulesCheckManager.getCheckRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `Check.` Providing an empty array tests if a `Check` can be created with no records.
Parameters	`osid.type.Type[]`	`checkRecordTypes`	array of check record types
Return	`boolean`		`true` if `Check` creation using the specified record `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`checkRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	createCheck
Description	Creates a new `Check.`
Parameters	`osid.rules.check.CheckForm`	`checkForm`	the form for this `Check`
Return	`osid.rules.check.Check`		the new `Check`
Errors	ILLEGAL_STATE		`checkForm` already used in a create transaction
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`checkForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`checkForm` did not originat from `getCheckFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdateChecks
Description	Tests if this user can update `Checks.` A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a `Check` 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 `Check` modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getCheckFormForUpdate
Description	Gets the check form for updating an existing hold. A new check form should be requested for each update transaction.
Parameters	`osid.id.Id`	`checkId`	the `Id` of the `Check`
Return	`osid.rules.check.CheckForm`		the check form
Errors	NOT_FOUND		`checkId` is not found
	NULL_ARGUMENT		`checkId` is `null`
	OPERATION_FAILED		unable to complete request
Compliance	`mandatory`		This method must be implemented.
Method	updateCheck
Description	Updates an existing hold.
Parameters	`osid.rules.check.CheckForm`	`checkForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`checkForm` already used in an update transaction
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`checkId` or `checkForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`checkForm` did not originat from `getCheckFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeleteChecks
Description	Tests if this user can delete `Checks.` A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting a `Check` 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 `Check` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deleteCheck
Description	Deletes a `Check.`
Parameters	`osid.id.Id`	`checkId`	the `Id` of the `Check` to remove
Errors	NOT_FOUND		`checkId` not found
	NULL_ARGUMENT		`checkId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageCheckAliases
Description	Tests if this user can manage `Id` aliases for `Checks.` 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 `Check` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasCheck
Description	Adds an `Id` to a `Check` for the purpose of creating compatibility. The primary `Id` of the `Check` is determined by the provider. The new `Id` performs as an alias to the primary `Id.` If the alias is a pointer to another check, it is reassigned to the given check `Id.`
Parameters	`osid.id.Id`	`checkId`	the `Id` of a `Check`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is already assigned
	NOT_FOUND		`checkId` not found
	NULL_ARGUMENT		`checkId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.