Interface | osid.inquiry.rules.InquiryEnablerInquestAssignmentSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session provides methods to re-assign Adding a reference of an | ||
Method | canAssignInquiryEnablers | ||
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
| ||
Return | boolean | false if mapping is not authorized, true
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | canAssignInquiryEnablersToInquest | ||
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
| ||
Parameters | osid.id.Id | inquestId | the Id of the Inquest |
Return | boolean | false if mapping is not authorized, true
otherwise | |
Errors | NULL_ARGUMENT | inquestId is null | |
Compliance | mandatory | This method must be implemented. | |
Method | getAssignableInquestIds | ||
Description |
Gets a list of inquests including and under the given inquest node in which any inquiry enabler can be assigned. | ||
Parameters | osid.id.Id | inquestId | the Id of the Inquest |
Return | osid.id.IdList | list of assignable inquest Ids | |
Errors | NULL_ARGUMENT | inquestId is null | |
OPERATION_FAILED | unable to complete request | ||
Compliance | mandatory | This method must be implemented. | |
Method | getAssignableInquestIdsForInquiryEnabler | ||
Description |
Gets a list of inquests including and under the given inquest node in which a specific inquiry enabler can be assigned. | ||
Parameters | osid.id.Id | inquestId | the Id of the Inquest |
osid.id.Id | inquiryEnablerId | the Id of the InquiryEnabler | |
Return | osid.id.IdList | list of assignable inquest Ids | |
Errors | NULL_ARGUMENT | inquestId or inquiryEnablerId is null
| |
OPERATION_FAILED | unable to complete request | ||
Compliance | mandatory | This method must be implemented. | |
Method | assignInquiryEnablerToInquest | ||
Description |
Adds an existing | ||
Parameters | osid.id.Id | inquiryEnablerId | the Id of the InquiryEnabler |
osid.id.Id | inquestId | the Id of the Inquest | |
Errors | ALREADY_EXISTS | inquiryEnablerId already assigned to inquestId
| |
NOT_FOUND | inquiryEnablerId or inquestId not found | ||
NULL_ARGUMENT | inquiryEnablerId or inquestId is null
| ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | unassignInquiryEnablerFromInquest | ||
Description |
Removes an | ||
Parameters | osid.id.Id | inquiryEnablerId | the Id of the InquiryEnabler |
osid.id.Id | inquestId | the Id of the Inquest | |
Errors | NOT_FOUND | inquiryEnablerId or inquestId not found or
inquiryEnablerId already assigned to inquestId | |
NULL_ARGUMENT | inquiryEnablerId or inquestId is null
| ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | reassignInquiryEnablerToInquest | ||
Description |
Moves an | ||
Parameters | osid.id.Id | inquiryEnablerId | the Id of the InquiryEnabler |
osid.id.Id | fromInquestId | the Id of the current Inquest | |
osid.id.Id | toInquestId | the Id of the destination Inquest | |
Errors | NOT_FOUND | inquiryEnabler, fromInquestId, or toInquestId
not found or inquiryEnabler not mapped to fromInquestId
| |
NULL_ARGUMENT | inquiryEnabler, fromInquestId, or toInquestId
is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |