| Interface | osid.hold.rules.IssueProcessorEnablerRuleApplicationSession | ||
|---|---|---|---|
| Implements | osid.OsidSession | ||
| Used By | osid.hold.rules.HoldRulesManager | ||
osid.hold.rules.HoldRulesProxyManager | |||
| Description |
This session provides methods to apply
| ||
| Method | getOublietteId | ||
| Description |
Gets the | ||
| Return | osid.id.Id | the Oubliette Id associated with this session | |
| Compliance | mandatory | This method must be implemented. | |
| Method | getOubliette | ||
| Description |
Gets the | ||
| Return | osid.hold.Oubliette | the oubliette | |
| Errors | OPERATION_FAILED | unable to complete request | |
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | canAssignIssueProcessorEnablers | ||
| Description |
Tests if this user can alter issue processor
enabler/issue processor 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 | assignIssueProcessorEnablerToIssueProcessor | ||
| Description |
Adds an existing | ||
| Parameters | osid.id.Id | issueProcessorEnablerId | the Id of the IssueProcessorEnabler |
osid.id.Id | issueProcessorId | the Id of the IssueProcessor | |
| Errors | ALREADY_EXISTS | issueProcessorEnablerId already applied to
issueProcessorId | |
| NOT_FOUND | issueProcessorEnablerId or issueProcessorId not
found | ||
| NULL_ARGUMENT | issueProcessorEnablerId or issueProcessorId is
null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | unassignIssueProcessorEnablerFromIssueProcessor | ||
| Description |
Removes an existing | ||
| Parameters | osid.id.Id | issueProcessorEnablerId | the Id of the IssueProcessorEnabler |
osid.id.Id | issueProcessorId | the Id of the IssueProcessor | |
| Errors | NOT_FOUND | issueProcessorEnablerId or issueProcessorId not
found or issueProcessorEnablerId already applied to
issueProcessorId | |
| NULL_ARGUMENT | issueProcessorEnablerId or issueProcessorId is
null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | canSequenceIssueProcessorEnablers | ||
| Description |
Tests if this user can order
| ||
| Return | boolean | false if IssueProcessorEnabler ordering is not
authorized, true otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | moveIssueProcessorEnablerAhead | ||
| Description |
Reorders issue processor enablers for an issue processor by moving the specified issue processor enabler in front of a reference issue processor enabler. | ||
| Parameters | osid.id.Id | issueProcessorEnablerId | the Id of the IssueProcessorEnabler |
osid.id.Id | issueProcessorId | the Id of the IssueProcessor | |
osid.id.Id | referenceId | the reference issue processor enabler Id | |
| Errors | NOT_FOUND | issueProcessorEnablerId issueProcessorId, or
referenceId not found or, issueProcessorEnablerId or
referenceId not related to issueProcessorId | |
| NULL_ARGUMENT | issueProcessorEnablerId, issueProcessorId, or
referenceId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | moveIssueProcessorEnablerBehind | ||
| Description |
Reorders issue processor enablers for an issue processor by moving the specified issue processor enabler behind a reference issue processor enabler. | ||
| Parameters | osid.id.Id | issueProcessorEnablerId | the Id of the IssueProcessorEnabler |
osid.id.Id | issueProcessorId | the Id of the IssueProcessor | |
osid.id.Id | referenceId | the reference issue processor Id | |
| Errors | NOT_FOUND | issueProcessorEnablerId issueProcessorId, or
referenceId not found or, issueProcessorEnablerId or
referenceId not related to issueProcessorId | |
| NULL_ARGUMENT | issueProcessorEnablerId, issueProcessorId, or
referenceId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | orderIssueProcessorEnablers | ||
| Description |
Reorders a set of issue processor enablers for an issue processor. | ||
| Parameters | osid.id.Id[] | issueProcessorEnablerIds | the Ids for a set of IssueProcessorEnablers |
osid.id.Id | issueProcessorId | the Id of the IssueProcessor | |
| Errors | NOT_FOUND | issueProcessorId not found or, an
issueProcessorEnablerId not related to
issueProcessorId | |
| NULL_ARGUMENT | issueProcessorEnablerIds or issueProcessorId is
null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |