| Interface | osid.inquiry.rules.AuditProcessorEnablerInquestAssignmentSession | ||
|---|---|---|---|
| Implements | osid.OsidSession | ||
| Used By | osid.inquiry.rules.InquiryRulesManager | ||
osid.inquiry.rules.InquiryRulesProxyManager | |||
| Description |
This session provides methods to re-assign
Adding a reference of an
| ||
| Method | canAssignAuditProcessorEnablers | ||
| Description |
Tests if this user can alter audit processor
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 | canAssignAuditProcessorEnablerToInquest | ||
| Description |
Tests if this user can alter audit processor
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 audit processor 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 | getAssignableInquestIdsForAuditProcessorEnabler | ||
| Description |
Gets a list of inquests including and under the given inquest node in which a specific audit processor enabler can be assigned. | ||
| Parameters | osid.id.Id | inquestId | the Id of the Inquest |
osid.id.Id | auditProcessorEnablerId | the Id of the AuditProcessorEnabler | |
| Return | osid.id.IdList | list of assignable inquest Ids | |
| Errors | NULL_ARGUMENT | inquestId or auditProcessorEnablerId is
null | |
| OPERATION_FAILED | unable to complete request | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | assignAuditProcessorEnablerToInquest | ||
| Description |
Adds an existing | ||
| Parameters | osid.id.Id | auditProcessorEnablerId | the Id of the AuditProcessorEnabler |
osid.id.Id | inquestId | the Id of the Inquest | |
| Errors | ALREADY_EXISTS | auditProcessorEnablerId is already assigned to
inquestId | |
| NOT_FOUND | auditProcessorEnablerId or inquestId not found | ||
| NULL_ARGUMENT | auditProcessorEnablerId or inquestId is
null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | unassignAuditProcessorEnablerFromInquest | ||
| Description |
Removes an | ||
| Parameters | osid.id.Id | auditProcessorEnablerId | the Id of the AuditProcessorEnabler |
osid.id.Id | inquestId | the Id of the Inquest | |
| Errors | NOT_FOUND | auditProcessorEnablerId or inquestId not found
or auditProcessorEnablerId not assigned to inquestId | |
| NULL_ARGUMENT | auditProcessorEnablerId or inquestId is
null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | reassignAuditProcessorEnablerToInquest | ||
| Description |
Moves an | ||
| Parameters | osid.id.Id | auditProcessorEnablerId | the Id of the AuditProcessorEnabler |
osid.id.Id | fromInquestId | the Id of the current Inquest | |
osid.id.Id | toInquestId | the Id of the destination Inquest | |
| Errors | ALREADY_EXISTS | auditProcessorEnablerId already assigned to
toInquestId | |
| NOT_FOUND | auditProcessorEnablerId, fromInquestId, or
toInquestId not found or auditProcessorEnablerId not
mapped to fromInquestId | ||
| NULL_ARGUMENT | auditProcessorEnablerId, fromInquestId, or
toInquestId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |