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

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

MethodcanAssignInquiries
Description

Tests if this user can alter inquiry/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 control is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodcanAssignInquiriesToInquest
Description

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

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

Parametersosid.id.IdinquestIdthe Id of the Inquest
osid.id.IdinquiryIdthe Id of the Inquiry
Returnosid.id.IdListlist of assignable inquest Ids
ErrorsNULL_ARGUMENT inquestId or inquiryId is null
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodassignInquiryToInquest
Description

Adds an existing Inquiry to an Inquest.

Parametersosid.id.IdinquiryIdthe Id of the Inquiry
osid.id.IdinquestIdthe Id of the Inquest
ErrorsALREADY_EXISTS inquiryId is slready assigned to inquestId
NOT_FOUND inquiryId or inquestId not found
NULL_ARGUMENT inquiryId or inquestId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodunassignInquiryFromInquest
Description

Removes an Inquiry from an Inquest.

Parametersosid.id.IdinquiryIdthe Id of the Inquiry
osid.id.IdinquestIdthe Id of the Inquest
ErrorsNOT_FOUND inquiryId or inquestId not found or inquiryId not assigned to inquestId
NULL_ARGUMENT inquiryId or inquestId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodreassignInquiryToInquest
Description

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

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