| Interface | osid.inquiry.rules.AuditConstrainerEnablerRuleApplicationSession | ||
|---|---|---|---|
| Implements | osid.OsidSession | ||
| Used By | osid.inquiry.rules.InquiryRulesManager | ||
osid.inquiry.rules.InquiryRulesProxyManager | |||
| Description |
This session provides methods to apply
| ||
| Method | getInquestId | ||
| Description |
Gets the | ||
| Return | osid.id.Id | the Inquest Id associated with this session | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getInquest | ||
| Description |
Gets the | ||
| Return | osid.inquiry.Inquest | the inquest | |
| Errors | OPERATION_FAILED | unable to complete request | |
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | canAssignAuditConstrainerEnablers | ||
| Description |
Tests if this user can alter audit constrainer
enabler/audit constrainer 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 | assignAuditConstrainerEnablerToAuditConstrainer | ||
| Description |
Adds an existing | ||
| Parameters | osid.id.Id | auditConstrainerEnablerId | the Id of the AuditConstrainerEnabler |
osid.id.Id | auditConstrainerId | the Id of the AuditConstrainer | |
| Errors | ALREADY_EXISTS | auditConstrainerEnablerId already applied to
auditConstrainerId | |
| NOT_FOUND | auditConstrainerEnablerId or auditConstrainerId
not found | ||
| NULL_ARGUMENT | auditConstrainerEnablerId or auditConstrainerId
is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | unassignAuditConstrainerEnablerFromAuditConstrainer | ||
| Description |
Removes an existing
| ||
| Parameters | osid.id.Id | auditConstrainerEnablerId | the Id of the AuditConstrainerEnabler |
osid.id.Id | auditConstrainerId | the Id of the AuditConstrainer | |
| Errors | NOT_FOUND | auditConstrainerEnablerId or auditConstrainerId
not found or auditConstrainerEnablerId already applied to
auditConstrainerId | |
| NULL_ARGUMENT | auditConstrainerEnablerId or auditConstrainerId
is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | canSequenceAuditConstrainerEnablers | ||
| Description |
Tests if this user can order
| ||
| Return | boolean | false if AuditConstrainerEnabler ordering is not
authorized, true otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | moveAuditConstrainerEnablerAhead | ||
| Description |
Reorders audit constrainer enablers for an audit constrainer by moving the specified audit constrainer enabler in front of a reference audit constrainer enabler. | ||
| Parameters | osid.id.Id | auditConstrainerEnablerId | the Id of the AuditConstrainerEnabler |
osid.id.Id | auditConstrainerId | the Id of the AuditConstrainer | |
osid.id.Id | referenceId | the reference audit constrainer enabler Id | |
| Errors | NOT_FOUND | auditConstrainerEnablerId auditConstrainerId, or
referenceId not found or, auditConstrainerEnablerId
or referenceId not related to auditConstrainerId | |
| NULL_ARGUMENT | auditConstrainerEnablerId, auditConstrainerId, or
referenceId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | moveAuditConstrainerEnablerBehind | ||
| Description |
Reorders audit constrainer enablers for an audit constrainer by moving the specified audit constrainer enabler behind a reference audit constrainer enabler. | ||
| Parameters | osid.id.Id | auditConstrainerEnablerId | the Id of the AuditConstrainerEnabler |
osid.id.Id | auditConstrainerId | the Id of the AuditConstrainer | |
osid.id.Id | referenceId | the reference audit constrainer Id | |
| Errors | NOT_FOUND | auditConstrainerEnablerId auditConstrainerId, or
referenceId not found or, auditConstrainerEnablerId
or referenceId not related to auditConstrainerId | |
| NULL_ARGUMENT | auditConstrainerEnablerId, auditConstrainerId, or
referenceId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | orderAuditConstrainerEnablers | ||
| Description |
Reorders a set of audit constrainer enablers for an audit constrainer. | ||
| Parameters | osid.id.Id[] | auditConstrainerEnablerIds | the Ids for a set of AuditConstrainerEnablers |
osid.id.Id | auditConstrainerId | the Id of the AuditConstrainer | |
| Errors | NOT_FOUND | auditConstrainerId not found or, an
auditConstrainerEnablerId not related to
auditConstrainerId | |
| NULL_ARGUMENT | auditConstrainerEnablerIds or auditConstrainerId
is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |