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

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

MethodcanAssignAuditConstrainers
Description

Tests if this user can alter audit constrainer/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.
MethodcanAssignAuditConstrainerToInquest
Description

Tests if this user can alter audit constrainer/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 constrainer 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.
MethodgetAssignableInquestIdsForAuditConstrainer
Description

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

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

Adds an existing AuditConstrainer to an Inquest.

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

Removes an AuditConstrainer from an Inquest.

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

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

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