OSID Logo
OSID Specifications
inquiry package
Version 3.1.0
Interfaceosid.inquiry.ResponseInquestAssignmentSession
Implementsosid.OsidSession
Used Byosid.inquiry.InquiryManager
osid.inquiry.InquiryProxyManager
Description

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

MethodcanAssignResponses
Description

Tests if this user can alter response/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 response is not authorized, true otherwise
Compliancemandatory This method must be implemented.
MethodcanAssignResponsesToInquest
Description

Tests if this user can alter response/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.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 response 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.
MethodgetAssignableInquestIdsForResponse
Description

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

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

Adds an existing Response to a Inquest.

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

Removes a Response from a Inquest.

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

Moves a Response from one Inquest to another. Mappings to other Inquests are unaffected.

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