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

This session provides methods to re-assign AuditEnabler to Inquest mappings. An AuditEnabler may appear in multiple Inquest objects and removing the last reference to an AuditEnabler is the equivalent of deleting it. Each Inquest may have its own authorizations governing who is allowed to operate on it.

Adding a reference of an AuditEnabler to another Inquest is not a copy operation (eg: does not change its Id ).

MethodcanAssignAuditEnablers
Description

Tests if this user can alter audit enabler/inquest mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known mapping methods in this session will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer lookup operations to unauthorized users.

Returnboolean false if mapping is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodcanAssignAuditEnablersToInquest
Description

Tests if this user can alter audit enabler/inquest mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known mapping methods in this session will result in a PERMISSION_DENIED. This is intended as a hint to an application that may opt not to offer lookup operations to unauthorized users.

Parametersosid.id.IdinquestIdthe Id of the Inquest
Returnboolean false if mapping is not authorized, true otherwise
ErrorsNULL_ARGUMENT inquestId is null
CompliancemandatoryThis method must be implemented.
MethodgetAssignableInquestIds
Description

Gets a list of inquests including and under the given inquest node in which any audit enabler can be assigned.

Parametersosid.id.IdinquestIdthe Id of the Inquest
Returnosid.id.IdListlist of assignable inquest Ids
ErrorsNULL_ARGUMENT inquestId is null
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetAssignableInquestIdsForAuditEnabler
Description

Gets a list of inquests including and under the given inquest node in which a specific audit enabler can be assigned.

Parametersosid.id.IdinquestIdthe Id of the Inquest
osid.id.IdauditEnablerIdthe Id of the AuditEnabler
Returnosid.id.IdListlist of assignable inquest Ids
ErrorsNULL_ARGUMENT inquestId or auditEnablerId is null
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodassignAuditEnablerToInquest
Description

Adds an existing AuditEnabler to an Inquest.

Parametersosid.id.IdauditEnablerIdthe Id of the AuditEnabler
osid.id.IdinquestIdthe Id of the Inquest
ErrorsALREADY_EXISTS auditEnablerId already assigned to inquestId
NOT_FOUND auditEnablerId or inquestId not found
NULL_ARGUMENT auditEnablerId or inquestId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodunassignAuditEnablerFromInquest
Description

Removes an AuditEnabler from an Inquest.

Parametersosid.id.IdauditEnablerIdthe Id of the AuditEnabler
osid.id.IdinquestIdthe Id of the Inquest
ErrorsNOT_FOUND auditEnablerId or inquestId not found or auditEnablerId already assigned to inquestId
NULL_ARGUMENT auditEnablerId or inquestId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodreassignAuditEnablerEnablerToInquest
Description

Moves an AuditEnabler from one Inquest to another. Mappings to other Inquests are unaffected.

Parametersosid.id.IdauditEnablerIdthe Id of the AuditEnabler
osid.id.IdfromInquestIdthe Id of the current Inquest
osid.id.IdtoInquestIdthe Id of the destination Inquest
ErrorsNOT_FOUND auditEnabler, fromInquestId, or toInquestId not found or auditEnabler not mapped to fromInquestId
NULL_ARGUMENT auditEnabler, fromInquestId, or toInquestId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.