OSID Logo
OSID Specifications
inquiry rules package
Version 3.0.0
Release Candidate Preview
Interfaceosid.inquiry.rules.AuditEnablerAdminSession
Implementsosid.OsidSession
Description

This session creates and removes audit enablers. The data for create and update is provided via the AuditEnablerForm.

MethodgetInquestId
Description

Gets the Inquest Id associated with this session.

Returnosid.id.Idthe Inquest Id associated with this session
CompliancemandatoryThis method must be implemented.
MethodgetInquest
Description

Gets the Inquest associated with this session.

Returnosid.inquiry.Inquestthe inquest
ErrorsOPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanCreateAuditEnabler
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.

Returnboolean false if AuditEnabler creation is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodcanCreateAuditEnablerWithRecordTypes
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.

Parametersosid.type.Type[]auditEnablerRecordTypesarray of audit enabler record types
Returnboolean true if AuditEnabler creation using the specified record Types is supported, false otherwise
ErrorsNULL_ARGUMENT auditEnablerRecordTypes is null
CompliancemandatoryThis method must be implemented.
MethodgetAuditEnablerFormForCreate
Description

Gets the audit enabler form for creating new audit enablers. A new form should be requested for each create transinquiry.

Parametersosid.type.Type[]auditEnablerRecordTypesarray of audit enabler record types
Returnosid.inquiry.rules.AuditEnablerFormthe audit enabler form
ErrorsNULL_ARGUMENT auditEnablerRecordTypes is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTEDunable to get form for requested record types
CompliancemandatoryThis method must be implemented.
MethodcreateAuditEnabler
Description

Creates a new AuditEnabler.

Parametersosid.inquiry.rules.AuditEnablerFormauditEnablerFormthe form for this AuditEnabler
Returnosid.inquiry.rules.AuditEnablerthe new AuditEnabler
ErrorsILLEGAL_STATE auditEnablerForm already used in a create transinquiry
INVALID_ARGUMENTone or more of the form elements is invalid
NULL_ARGUMENT auditEnablerForm is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED auditEnablerForm did not originate from getAuditEnablerFormForCreate()
CompliancemandatoryThis method must be implemented.
MethodcanUpdateAuditEnablers
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.

Returnboolean false if AuditEnabler modification is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodgetAuditEnablerFormForUpdate
Description

Gets the audit enabler form for updating an existing audit enabler. A new audit enabler form should be requested for each update transinquiry.

Parametersosid.id.IdauditEnablerIdthe Id of the AuditEnabler
Returnosid.inquiry.rules.AuditEnablerFormthe audit enabler form
ErrorsNOT_FOUND auditEnablerId is not found
NULL_ARGUMENT auditEnablerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodupdateAuditEnabler
Description

Updates an existing audit enabler.

Parametersosid.inquiry.rules.AuditEnablerFormauditEnablerFormthe form containing the elements to be updated
ErrorsILLEGAL_STATE auditEnablerForm already used in an update transinquiry
INVALID_ARGUMENTthe form contains an invalid value
NULL_ARGUMENT auditEnablerForm is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED auditEnablerForm did not originate from getAuditEnablerFormForUpdate()
CompliancemandatoryThis method must be implemented.
MethodcanDeleteAuditEnablers
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.

Returnboolean false if AuditEnabler deletion is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethoddeleteAuditEnabler
Description

Deletes an AuditEnabler.

Parametersosid.id.IdauditEnablerIdthe Id of the AuditEnabler to remove
ErrorsNOT_FOUND auditEnablerId not found
NULL_ARGUMENT auditEnablerId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodcanManageAuditEnablerAliases
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.

Returnboolean false if AuditEnabler aliasing is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodaliasAuditEnabler
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.

Parametersosid.id.IdauditEnablerIdthe Id of an AuditEnabler
osid.id.IdaliasIdthe alias Id
ErrorsALREADY_EXISTS aliasId is already assigned
NOT_FOUND auditEnablerId not found
NULL_ARGUMENT auditEnablerId or aliasId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.