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

Interface	osid.inquiry.rules.AuditEnablerAdminSession
Implements	`osid.OsidSession`
Description	This session creates and removes audit enablers. The data for create and update is provided via the `AuditEnablerForm.`
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	canCreateAuditEnabler
Description	Tests if this user can create audit enablers. A return of true does not guarantee successful authorization. A return of false indicates that it is known creating an `AuditEnabler` 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 `AuditEnabler` creation is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	canCreateAuditEnablerWithRecordTypes
Description	Tests if this user can create a single `AuditEnabler` using the desired record types. While `InquiryRulesManager.getAuditEnablerRecordTypes()` can be used to examine which records are supported, this method tests which record(s) are required for creating a specific `AuditEnabler.` Providing an empty array tests if an `AuditEnabler` can be created with no records.
Parameters	`osid.type.Type[]`	`auditEnablerRecordTypes`	array of audit enabler record types
Return	`boolean`		`true` if `AuditEnabler` creation using the specified record `Types` is supported, `false` otherwise
Errors	NULL_ARGUMENT		`auditEnablerRecordTypes` is `null`
Compliance	`mandatory`		This method must be implemented.
Method	getAuditEnablerFormForCreate
Description	Gets the audit enabler form for creating new audit enablers. A new form should be requested for each create transinquiry.
Parameters	`osid.type.Type[]`	`auditEnablerRecordTypes`	array of audit enabler record types
Return	`osid.inquiry.rules.AuditEnablerForm`		the audit enabler form
Errors	NULL_ARGUMENT		`auditEnablerRecordTypes` 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	createAuditEnabler
Description	Creates a new `AuditEnabler.`
Parameters	`osid.inquiry.rules.AuditEnablerForm`	`auditEnablerForm`	the form for this `AuditEnabler`
Return	`osid.inquiry.rules.AuditEnabler`		the new `AuditEnabler`
Errors	ILLEGAL_STATE		`auditEnablerForm` already used in a create transinquiry
	INVALID_ARGUMENT		one or more of the form elements is invalid
	NULL_ARGUMENT		`auditEnablerForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`auditEnablerForm did not originate from getAuditEnablerFormForCreate()`
Compliance	`mandatory`		This method must be implemented.
Method	canUpdateAuditEnablers
Description	Tests if this user can update audit enablers. A return of true does not guarantee successful authorization. A return of false indicates that it is known updating an `AuditEnabler` 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 `AuditEnabler` modification is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	getAuditEnablerFormForUpdate
Description	Gets the audit enabler form for updating an existing audit enabler. A new audit enabler form should be requested for each update transinquiry.
Parameters	`osid.id.Id`	`auditEnablerId`	the `Id` of the `AuditEnabler`
Return	`osid.inquiry.rules.AuditEnablerForm`		the audit enabler form
Errors	NOT_FOUND		`auditEnablerId` is not found
	NULL_ARGUMENT		`auditEnablerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	updateAuditEnabler
Description	Updates an existing audit enabler.
Parameters	`osid.inquiry.rules.AuditEnablerForm`	`auditEnablerForm`	the form containing the elements to be updated
Errors	ILLEGAL_STATE		`auditEnablerForm` already used in an update transinquiry
	INVALID_ARGUMENT		the form contains an invalid value
	NULL_ARGUMENT		`auditEnablerForm` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
	UNSUPPORTED		`auditEnablerForm` did not originate from `getAuditEnablerFormForUpdate()`
Compliance	`mandatory`		This method must be implemented.
Method	canDeleteAuditEnablers
Description	Tests if this user can delete audit enablers. A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting an `AuditEnabler` 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 `AuditEnabler` deletion is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	deleteAuditEnabler
Description	Deletes an `AuditEnabler.`
Parameters	`osid.id.Id`	`auditEnablerId`	the `Id` of the `AuditEnabler` to remove
Errors	NOT_FOUND		`auditEnablerId` not found
	NULL_ARGUMENT		`auditEnablerId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.
Method	canManageAuditEnablerAliases
Description	Tests if this user can manage `Id` aliases for audit enablers. 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 `AuditEnabler` aliasing is not authorized, `true` otherwise
Compliance	`mandatory`		This method must be implemented.
Method	aliasAuditEnabler
Description	Adds an `Id` to an `AuditEnabler` for the purpose of creating compatibility. The primary `Id` of the `AuditEnabler` 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 enabler. it is reassigned to the given audit enabler `Id.`
Parameters	`osid.id.Id`	`auditEnablerId`	the `Id` of an `AuditEnabler`
Parameters	`osid.id.Id`	`aliasId`	the alias `Id`
Errors	ALREADY_EXISTS		`aliasId` is already assigned
	NOT_FOUND		`auditEnablerId` not found
	NULL_ARGUMENT		`auditEnablerId` or `aliasId` is `null`
	OPERATION_FAILED		unable to complete request
	PERMISSION_DENIED		authorization failure
Compliance	`mandatory`		This method must be implemented.