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

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