OSID - osid.inquiry.rules.AuditConstrainerAdminSession Service Interface Definition

Interface	osid.inquiry.rules.AuditConstrainerAdminSession
Implements	`osid.OsidSession`
Used By	`osid.inquiry.rules.InquiryRulesManager`
Used By	`osid.inquiry.rules.InquiryRulesProxyManager`
Description	This session creates, updates, and deletes `AuditConstrainers`. 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 an `AuditConstrainer`, an `AuditConstrainerForm` is requested using `getAuditConstrainerFormForCreate()` specifying the desired record `Types` or none if no record `Types` are needed. The returned `AuditConstrainerForm` 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 `AuditConstrainerForm` is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each `AuditConstrainerForm` corresponds to an attempted transaction. For updates, `AuditConstrainerForms` are requested to the `AuditConstrainer` `Id` that is to be updated using `getAuditConstrainerFormForUpdate()`. Similarly, the `AuditConstrainerForm` has metadata about the data that can be updated and it can perform validation before submitting the update. The `AuditConstrainerForm` can only be used once for a successful update and cannot be reused. The delete operations delete `AuditConstrainers`. To unmap an `AuditConstrainer` from the current `Inquest`, the `AuditConstrainerInquestAssignmentSession` should be used. These delete operations attempt to remove the `AuditConstrainer` itself thus removing it from all known `Inquest` catalogs. This session includes an `Id` aliasing mechanism to assign an external `Id` to an internally assigned `Id`.
Method	getInquestId
Description	Gets the `Inquest` `Id` associated with this session.
Return	`osid.id.Id`		the `Inquest Id` associated with this session
Compliance	`mandatory`		This method must be implemented.
Method	getInquest
Description	Gets the `Inquest` associated with this session.
Return	`osid.inquiry.Inquest`		the inquest
Errors	OPERATION_FAILED		unable to complete request
Errors	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canCreateAuditConstrainers
Description	Tests if this user can create `AuditConstrainers`. A return of true does not guarantee successful authorization. A return of false indicates that it is known creating an `AuditConstrainer` will result in a `PERMISSION_DENIED. T` his is intended as a hint to an application that may opt not to offer create operations to an unauthorized user.
Return	`boolean`		`false` if `AuditConstrainer` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreateAuditConstrainerWithRecordTypes
Description	Tests if this user can create a single `AuditConstrainer` using the desired record types. While `InquiryRulesManager.getAuditConstrainerRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `AuditConstrainer`. Providing an empty array tests if an `AuditConstrainer can be cr` eated with no records.
Parameters	`osid.type.Type[]`	`auditConstrainerRecordTypes`	array of audit constrainer record types
Return	`boolean`		`true` if `AuditConstrainer` creation using the specified record `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`auditConstrainerRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getAuditConstrainerFormForCreate
Description	Gets the audit constrainer form for creating new audit constrainers. A new form should be requested for each create transaction.
Parameters	`osid.type.Type[]`	`auditConstrainerRecordTypes`	array of audit constrainer record types
Return	`osid.inquiry.rules.AuditConstrainerForm`		the audit constrainer form
Errors	NULL_ARGUMENT		`auditConstrainerRecordTypes` 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	createAuditConstrainer
Description	Creates a new `AuditConstrainer`.
Parameters	`osid.inquiry.rules.AuditConstrainerForm`	`auditConstrainerForm`	the form for this `AuditConstrainer`
Return	`osid.inquiry.rules.AuditConstrainer`		the new `AuditConstrainer`
Errors	ILLEGAL_STATE		`auditConstrainerForm` already used in a create transaction
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`auditConstrainerForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`auditConstrainerForm` did not originate from `getAuditConstrainerFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdateAuditConstrainers
Description	Tests if this user can update `AuditConstrainers`. A return of true does not guarantee successful authorization. A return of false indicates that it is known updating an `AuditConstrainer` will result in a `PERMISSION_DENIED. T` his is intended as a hint to an application that may opt not to offer update operations to an unauthorized user.
Return	`boolean`		`false` if `AuditConstrainer` modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getAuditConstrainerFormForUpdate
Description	Gets the audit constrainer form for updating an existing audit constrainer. A new audit constrainer form should be requested for each update transaction.
Parameters	`osid.id.Id`	`auditConstrainerId`	the `Id` of the `AuditConstrainer`
Return	`osid.inquiry.rules.AuditConstrainerForm`		the audit form
Errors	NOT_FOUND		`auditConstrainerId` is not found
	NULL_ARGUMENT		`auditConstrainerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	updateAuditConstrainer
Description	Updates an existing audit constrainer.
Parameters	`osid.inquiry.rules.AuditConstrainerForm`	`auditConstrainerForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`auditConstrainerForm` already used in an update transaction
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`auditConstrainerForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`auditConstrainerForm` did not originate from `getAuditConstrainerFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeleteAuditConstrainers
Description	Tests if this user can delete `AuditConstrainers`. A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting an `AuditConstrainer` will result in a `PERMISSION_DENIED. T` his is intended as a hint to an application that may opt not to offer delete operations to an unauthorized user.
Return	`boolean`		`false` if `AuditConstrainer` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deleteAuditConstrainer
Description	Deletes an `AuditConstrainer`.
Parameters	`osid.id.Id`	`auditConstrainerId`	the `Id` of the `AuditConstrainer` to remove
Errors	NOT_FOUND		`auditConstrainerId` not found
	NULL_ARGUMENT		`auditConstrainerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageAuditConstrainerAliases
Description	Tests if this user can manage `Id` aliases for `AuditConstrainers` 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 `AuditConstrainer` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasAuditConstrainer
Description	Adds an `Id` to an `AuditConstrainer` for the purpose of creating compatibility. The primary `Id` of the `AuditConstrainer` is determined by the provider. The new `Id` performs as an alias to the primary `Id`. If the alias is a pointer to another audit constrainer, it is reassigned to the given audit constrainer Id.
Parameters	`osid.id.Id`	`auditConstrainerId`	the `Id` of an `AuditConstrainer`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is already assigned
	NOT_FOUND		`auditConstrainerId` not found
	NULL_ARGUMENT		`auditConstrainerId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.