OSID - osid.inquiry.AuditAdminSession Service Interface Definition

Interface	osid.inquiry.AuditAdminSession
Implements	`osid.OsidSession`
Description	This session creates, updates, and deletes `Audits.` 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 `Audit,` an `AuditForm` is requested using `getAuditFormForCreate()` specifying the desired record `Types` or none if no record `Types` are needed. The returned `AuditForm` 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 `AuditForm` is submiited to a create operation, it cannot be reused with another create operation unless the first operation was unsuccessful. Each `AuditForm` corresponds to an attempted transaction. For updates, `AuditForms` are requested to the `Audit` `Id` that is to be updated using `getAuditFormForUpdate().` Similarly, the `AuditForm` has metadata about the data that can be updated and it can perform validation before submitting the update. The `AuditForm` can only be used once for a successful update and cannot be reused. The delete operations delete `Audits.` To unmap an `Audit` from the current `Inquest,` the `AuditInquestAssignmentSession` should be used. These delete operations attempt to remove the `Audit` 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	canCreateAudit
Description	Tests if this user can create audits. A return of true does not guarantee successful authorization. A return of false indicates that it is known creating an `Audit` 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 `Audit` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreateAuditWithRecordTypes
Description	Tests if this user can create a single `Audit` using the desired record types. While `ControlManager.getAuditRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `Audit.` Providing an empty array tests if an `Audit` can be created with no records.
Parameters	`osid.type.Type[]`	`auditRecordTypes`	array of audit record types
Return	`boolean`		`true` if `Audit` creation using the specified record `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`auditRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getAuditFormForCreate
Description	Gets the audit form for creating new audits. A new form should be requested for each create transaction.
Parameters	`osid.type.Type[]`	`auditRecordTypes`	array of audit record types
Return	`osid.inquiry.AuditForm`		the audit form
Errors	NULL_ARGUMENT		`auditRecordTypes` 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	createAudit
Description	Creates a new `Audit.`
Parameters	`osid.inquiry.AuditForm`	`auditForm`	the form for this `Audit`
Return	`osid.inquiry.Audit`		the new `Audit`
Errors	ILLEGAL_STATE		`auditForm` already used in a create transaction
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`auditForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`auditForm` did not originate from `getAuditFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdateAudits
Description	Tests if this user can update audits. A return of true does not guarantee successful authorization. A return of false indicates that it is known updating an `Audit` 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 `Audit` modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getAuditFormForUpdate
Description	Gets the audit form for updating an existing audit. A new audit form should be requested for each update transaction.
Parameters	`osid.id.Id`	`auditId`	the `Id` of the `Audit`
Return	`osid.inquiry.AuditForm`		the audit form
Errors	NOT_FOUND		`auditId` is not found
	NULL_ARGUMENT		`auditId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	updateAudit
Description	Updates an existing audit.
Parameters	`osid.inquiry.AuditForm`	`auditForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`auditForm` already used in an update transaction
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`auditForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`auditForm` did not originate from `getAuditFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeleteAudits
Description	Tests if this user can delete audits. A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting an `Audit` 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 `Audit` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deleteAudit
Description	Deletes an `Audit.`
Parameters	`osid.id.Id`	`auditId`	the `Id` of the `Audit` to remove
Errors	NOT_FOUND		`auditId` not found
	NULL_ARGUMENT		`auditId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageAuditAliases
Description	Tests if this user can manage `Id` aliases for audits. 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 `Audit` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasAudit
Description	Adds an `Id` to an `Audit` for the purpose of creating compatibility. The primary `Id` of the `Audit` 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, it is reassigned to the given audit `Id.`
Parameters	`osid.id.Id`	`auditId`	the `Id` of an `Audit`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is already assigned
	NOT_FOUND		`auditId` not found
	NULL_ARGUMENT		`auditId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.