| Interface | osid.hold.rules.IssueConstrainerRuleApplicationSession | ||
|---|---|---|---|
| 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 | canAssignIssueConstrainers | ||
| Description |
Tests if this user can alter issue constrainer/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 | assignIssueConstrainerToIssue | ||
| Description |
Adds an existing | ||
| Parameters | osid.id.Id | issueConstrainerId | the Id of the IssueConstrainer |
osid.id.Id | issueId | the Id of the Issue | |
| Errors | ALREADY_EXISTS | issueConstrainerId already applied to issueId | |
| NOT_FOUND | issueConstrainerId or issueId not found | ||
| NULL_ARGUMENT | issueConstrainerId or issueId is
null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | unassignIssueConstrainerFromIssue | ||
| Description |
Removes an existing | ||
| Parameters | osid.id.Id | issueConstrainerId | the Id of the IssueConstrainer |
osid.id.Id | issueId | the Id of the Issue | |
| Errors | NOT_FOUND | issueConstrainerId or issueId not found or
issueConstrainerId already applied to issueId | |
| NULL_ARGUMENT | issueConstrainerId or issueId is
null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | canSequenceIssueConstrainers | ||
| Description |
Tests if this user can order
| ||
| Return | boolean | false if IssueConstrainer ordering is not
authorized, true otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | moveIssueConstrainerAhead | ||
| Description |
Reorders issue constrainers for an issue by moving the specified issue constrainer in front of a reference issue constrainer. | ||
| Parameters | osid.id.Id | issueConstrainerId | the Id of the IssueConstrainer |
osid.id.Id | issueId | the Id of the Issue | |
osid.id.Id | referenceId | the reference issue constrainer Id | |
| Errors | NOT_FOUND | issueConstrainerId, issueId, or referenceId not
found or, issueConstrainerId or referenceId not
related to issueId | |
| NULL_ARGUMENT | issueConstrainerId, issueId, or referenceId is
null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | moveIssueConstrainerBehind | ||
| Description |
Reorders issue constrainers for an issue by moving the specified issue constrainer behind a reference issue constrainer. | ||
| Parameters | osid.id.Id | issueConstrainerId | the Id of the IssueConstrainer |
osid.id.Id | issueId | the Id of the Issue | |
osid.id.Id | referenceId | the reference issue constrainer Id | |
| Errors | NOT_FOUND | issueConstrainerId, issueId, or referenceId not
found or, issueConstrainerId or referenceId not
related to issueId | |
| NULL_ARGUMENT | issueConstrainerId, issueId, or referenceId is
null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | orderIssueConstrainers | ||
| Description |
Reorders a set of issue constrainers for an issue. | ||
| Parameters | osid.id.Id[] | issueConstrainerIds | the Ids for a set of IssueConstrainers |
osid.id.Id | issueId | the Id of the Issue | |
| Errors | NOT_FOUND | issueId not found or, an issueConstrainerId not
related to issueId | |
| NULL_ARGUMENT | issueConstrainerIds or issueId is
null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |