OSID Logo
OSID Specifications
inquiry rules package
Version 3.1.0
Interfaceosid.inquiry.rules.AuditProcessorInquestAssignmentSession
Implementsosid.OsidSession
Used Byosid.inquiry.rules.InquiryRulesManager
osid.inquiry.rules.InquiryRulesProxyManager
Description

This session provides methods to re-assign AuditProcessor to Inquest mappings. An AuditProcessor may appear in multiple Inquest catalogs and removing the last reference to an AuditProcessor 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 AuditProcessor to another Inquest is not a copy operation (eg: does not change its Id).

MethodcanAssignAuditProcessors
Description

Tests if this user can alter audit processor/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. T his is intended as a hint to an application that may opt not to offer assignment operations to unauthorized users.

Returnboolean false if mapping is not authorized, true otherwise
Compliancemandatory This method must be implemented.
MethodcanAssignAuditProcessorToInquest
Description

Tests if this user can alter audit processor/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. T his is intended as a hint to an application that may opt not to offer assignment operations to unauthorized users.

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

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

Parametersosid.id.IdinquestId the Id of the Inquest
Returnosid.id.IdList list of assignable inquest Ids
ErrorsNULL_ARGUMENT inquestId is null
OPERATION_FAILED unable to complete request
Compliancemandatory This method must be implemented.
MethodgetAssignableInquestIdsForAuditProcessor
Description

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

Parametersosid.id.IdinquestId the Id of the Inquest
osid.id.IdauditProcessorId the Id of the AuditProcessor
Returnosid.id.IdList list of assignable inquest Ids
ErrorsNULL_ARGUMENT inquestId or auditProcessorId is null
OPERATION_FAILED unable to complete request
Compliancemandatory This method must be implemented.
MethodassignAuditProcessorToInquest
Description

Adds an existing AuditProcessor to an Inquest.

Parametersosid.id.IdauditProcessorId the Id of the AuditProcessor
osid.id.IdinquestId the Id of the Inquest
ErrorsALREADY_EXISTS auditProcessorId is already assigned to inquestId
NOT_FOUND auditProcessorId or inquestId not found
NULL_ARGUMENT auditProcessorId or inquestId is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethodunassignAuditProcessorFromInquest
Description

Removes an AuditProcessor from an Inquest.

Parametersosid.id.IdauditProcessorId the Id of the AuditProcessor
osid.id.IdinquestId the Id of the Inquest
ErrorsNOT_FOUND auditProcessorId or inquestId not found or auditProcessorId not assigned to inquestId
NULL_ARGUMENT auditProcessorId or inquestId is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.
MethodreassignAuditProcessorToInquest
Description

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

Parametersosid.id.IdauditProcessorId the Id of the AuditProcessor
osid.id.IdfromInquestId the Id of the current Inquest
osid.id.IdtoInquestId the Id of the destination Inquest
ErrorsALREADY_EXISTS auditProcessorId already assigned to toInquestId
NOT_FOUND auditProcessorId, fromInquestId, or toInquestId not found or auditProcessorId not mapped to fromInquestId
NULL_ARGUMENT auditProcessorId, fromInquestId, or toInquestId is null
OPERATION_FAILED unable to complete request
PERMISSION_DENIED authorization failure
Compliancemandatory This method must be implemented.