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

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

MethodcanAssignAudits
Description

Tests if this user can alter audit/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 assignment operations to unauthorized users.

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

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

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

Parametersosid.id.IdinquestIdthe Id of the Inquest
osid.id.IdauditIdthe Id of the Audit
Returnosid.id.IdListlist of assignable inquest Ids
ErrorsNULL_ARGUMENT inquestId or auditId is null
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodassignAuditToInquest
Description

Adds an existing Audit to a Inquest.

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

Removes an Audit from an Inquest.

Parametersosid.id.IdauditIdthe Id of the Audit
osid.id.IdinquestIdthe Id of the Inquest
ErrorsNOT_FOUND auditId or inquestId not found or auditId not assigned to inquestId
NULL_ARGUMENT auditId or inquestId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodreassignAuditToInquest
Description

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

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