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

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

MethodcanAssignAuditProcessorEnablers
Description

Tests if this user can alter audit processor 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. 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.
MethodcanAssignAuditProcessorEnablerToInquest
Description

Tests if this user can alter audit processor 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. 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 enabler 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.
MethodgetAssignableInquestIdsForAuditProcessorEnabler
Description

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

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

Adds an existing AuditProcessorEnabler to an Inquest.

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

Removes an AuditProcessorEnabler from an Inquest.

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

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

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