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

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

MethodcanAssignInquiryEnablers
Description

Tests if this user can alter inquiry 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.
MethodcanAssignInquiryEnablersToInquest
Description

Tests if this user can alter inquiry 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 inquiry 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.
MethodgetAssignableInquestIdsForInquiryEnabler
Description

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

Parametersosid.id.IdinquestIdthe Id of the Inquest
osid.id.IdinquiryEnablerIdthe Id of the InquiryEnabler
Returnosid.id.IdListlist of assignable inquest Ids
ErrorsNULL_ARGUMENT inquestId or inquiryEnablerId is null
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodassignInquiryEnablerToInquest
Description

Adds an existing InquiryEnabler to an Inquest.

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

Removes an InquiryEnabler from an Inquest.

Parametersosid.id.IdinquiryEnablerIdthe Id of the InquiryEnabler
osid.id.IdinquestIdthe Id of the Inquest
ErrorsNOT_FOUND inquiryEnablerId or inquestId not found or inquiryEnablerId already assigned to inquestId
NULL_ARGUMENT inquiryEnablerId or inquestId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodreassignInquiryEnablerToInquest
Description

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

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