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

Interface	osid.inquiry.rules.AuditProcessorAdminSession
Implements	`osid.OsidSession`
Used By	`osid.inquiry.rules.InquiryRulesManager`
Used By	`osid.inquiry.rules.InquiryRulesProxyManager`
Description	This session creates, updates, and deletes `AuditProcessors`. 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 `AuditProcessor`, an `AuditProcessorForm` is requested using `getAuditProcessorFormForCreate()` specifying the desired record `Types` or none if no record `Types` are needed. The returned `AuditProcessorForm` 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 `AuditProcessorForm` is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each `AuditProcessorForm` corresponds to an attempted transaction. For updates, `AuditProcessorForms` are requested to the `AuditProcessor` `Id` that is to be updated using `getAuditProcessorFormForUpdate()`. Similarly, the `AuditProcessorForm` has metadata about the data that can be updated and it can perform validation before submitting the update. The `AuditProcessorForm` can only be used once for a successful update and cannot be reused. The delete operations delete `AuditProcessors`. To unmap an `AuditProcessor` from the current `Inquest`, the `AuditProcessorInquestAssignmentSession` should be used. These delete operations attempt to remove the `AuditProcessor` 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	canCreateAuditProcessors
Description	Tests if this user can create `AuditProcessors`. A return of true does not guarantee successful authorization. A return of false indicates that it is known creating an `AuditProcessor` 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 `AuditProcessor` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreateAuditProcessorWithRecordTypes
Description	Tests if this user can create a single `AuditProcessor` using the desired record types. While `InquiryRulesManager.getAuditProcessorRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `AuditProcessor`. Providing an empty array tests if an `AuditProcessor can be cr` eated with no records.
Parameters	`osid.type.Type[]`	`auditProcessorRecordTypes`	array of audit processor record types
Return	`boolean`		`true` if `AuditProcessor` creation using the specified record `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`auditProcessorRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getAuditProcessorFormForCreate
Description	Gets the audit processor form for creating new audit processors. A new form should be requested for each create transaction.
Parameters	`osid.type.Type[]`	`auditProcessorRecordTypes`	array of audit processor record types
Return	`osid.inquiry.rules.AuditProcessorForm`		the audit processor form
Errors	NULL_ARGUMENT		`auditProcessorRecordTypes` 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	createAuditProcessor
Description	Creates a new `AuditProcessor`.
Parameters	`osid.inquiry.rules.AuditProcessorForm`	`auditProcessorForm`	the form for this `AuditProcessor`
Return	`osid.inquiry.rules.AuditProcessor`		the new `AuditProcessor`
Errors	ILLEGAL_STATE		`auditProcessorForm` already used in a create transaction
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`auditProcessorForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`auditProcessorForm` did not originate from `getAuditProcessorFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdateAuditProcessors
Description	Tests if this user can update `AuditProcessors`. A return of true does not guarantee successful authorization. A return of false indicates that it is known updating an `AuditProcessor` 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 `AuditProcessor` modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getAuditProcessorFormForUpdate
Description	Gets the audit processor form for updating an existing audit processor. A new audit processor form should be requested for each update transaction.
Parameters	`osid.id.Id`	`auditProcessorId`	the `Id` of the `AuditProcessor`
Return	`osid.inquiry.rules.AuditProcessorForm`		the audit processor form
Errors	NOT_FOUND		`auditProcessorId` is not found
	NULL_ARGUMENT		`auditProcessorId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	updateAuditProcessor
Description	Updates an existing audit processor.
Parameters	`osid.inquiry.rules.AuditProcessorForm`	`auditProcessorForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`auditProcessorForm` already used in an update transaction
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`auditProcessorForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`auditProcessorForm` did not originate from `getAuditProcessorFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeleteAuditProcessors
Description	Tests if this user can delete `AuditProcessors`. A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting an `AuditProcessor` 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 `AuditProcessor` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deleteAuditProcessor
Description	Deletes an `AuditProcessor`.
Parameters	`osid.id.Id`	`auditProcessorId`	the `Id` of the `AuditProcessor` to remove
Errors	NOT_FOUND		`auditProcessorId` not found
	NULL_ARGUMENT		`auditProcessorId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageAuditProcessorAliases
Description	Tests if this user can manage `Id` aliases for `AuditProcessors` 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 `AuditProcessor` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasAuditProcessor
Description	Adds an `Id` to an `AuditProcessor` for the purpose of creating compatibility. The primary `Id` of the `AuditProcessor` 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 processor, it is reassigned to the given audit processor `Id`.
Parameters	`osid.id.Id`	`auditProcessorId`	the `Id` of an `AuditProcessor`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is already assigned
	NOT_FOUND		`auditProcessorId` not found
	NULL_ARGUMENT		`auditProcessorId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.