| Interface | osid.hold.rules.IssueEnablerRuleApplicationSession | ||
|---|---|---|---|
| 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 | canAssignIssueEnablers | ||
| Description |
Tests if this user can alter issue enabler/issue
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 | assignIssueEnablerToIssue | ||
| Description |
Adds an existing | ||
| Parameters | osid.id.Id | issueEnablerId | the Id of the IssueEnabler |
osid.id.Id | issueId | the Id of the Issue | |
| Errors | ALREADY_EXISTS | issueEnablerId already applied to issueId | |
| NOT_FOUND | issueEnablerId or issueId not found | ||
| NULL_ARGUMENT | issueEnablerId or issueId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | unassignIssueEnablerFromIssue | ||
| Description |
Removes an existing | ||
| Parameters | osid.id.Id | issueEnablerId | the Id of the IssueEnabler |
osid.id.Id | issueId | the Id of the Issue | |
| Errors | NOT_FOUND | issueEnablerId or issueId not found or
issueEnablerId already applied to issueId | |
| NULL_ARGUMENT | issueEnablerId or issueId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | canSequenceIssueEnablers | ||
| Description |
Tests if this user can order
| ||
| Return | boolean | false if IssueEnabler ordering is not
authorized, true otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | moveIssueEnablerAhead | ||
| Description |
Reorders issue enablers for an issue by moving the specified issue enabler in front of a reference issue enabelrs. | ||
| Parameters | osid.id.Id | issueEnablerId | the Id of the IssueEnabler |
osid.id.Id | issueId | the Id of the Issue | |
osid.id.Id | referenceId | the reference issue enabler Id | |
| Errors | NOT_FOUND | issueEnablerId, issueId, or referenceId not
found or, issueEnablerId or referenceId not related
to issueId | |
| NULL_ARGUMENT | issueEnablerId, issueId, or referenceId is
null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | moveIssueEnablerBehind | ||
| Description |
Reorders issue enablers for an issue by moving the specified issue enabler behind a reference issue enabler. | ||
| Parameters | osid.id.Id | issueEnablerId | the Id of the IssueEnabler |
osid.id.Id | issueId | the Id of the Issue | |
osid.id.Id | referenceId | the reference issue enabler Id | |
| Errors | NOT_FOUND | issueEnablerId, issueId, or referenceId not
found or, issueEnablerId or referenceId not related
to issueId | |
| NULL_ARGUMENT | issueEnablerId, issueId, or referenceId is
null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | orderIssueEnablers | ||
| Description |
Reorders a set of issue enablers for an issue. | ||
| Parameters | osid.id.Id[] | issueEnablerIds | the Ids for a set of IssueEnablers |
osid.id.Id | issueId | the Id of the Issue | |
| Errors | NOT_FOUND | issueId not found or, an issueEnablerId not
related to issueId | |
| NULL_ARGUMENT | issueEnablerIds or issueId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |