| Interface | osid.hold.rules.IssueConstrainerEnablerRuleApplicationSession | ||
|---|---|---|---|
| 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 | canAssignIssueConstrainerEnablers | ||
| Description |
Tests if this user can alter issue constrainer
enabler/issue 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 | assignIssueConstrainerEnablerToIssueConstrainer | ||
| Description |
Adds an existing | ||
| Parameters | osid.id.Id | issueConstrainerEnablerId | the Id of the IssueConstrainerEnabler |
osid.id.Id | issueConstrainerId | the Id of the IssueConstrainer | |
| Errors | ALREADY_EXISTS | issueConstrainerEnablerId already applied to
issueConstrainerId | |
| NOT_FOUND | issueConstrainerEnablerId or issueConstrainerId
not found | ||
| NULL_ARGUMENT | issueConstrainerEnablerId or issueConstrainerId
is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | unassignIssueConstrainerEnablerFromIssueConstrainer | ||
| Description |
Removes an existing
| ||
| Parameters | osid.id.Id | issueConstrainerEnablerId | the Id of the IssueConstrainerEnabler |
osid.id.Id | issueConstrainerId | the Id of the IssueConstrainer | |
| Errors | NOT_FOUND | issueConstrainerEnablerId or issueConstrainerId
not found or issueConstrainerEnablerId already applied to
issueConstrainerId | |
| NULL_ARGUMENT | issueConstrainerEnablerId or issueConstrainerId
is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | canSequenceIssueConstrainerEnablers | ||
| Description |
Tests if this user can order
| ||
| Return | boolean | false if IssueConstrainerEnabler ordering is not
authorized, true otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | moveIssueConstrainerEnablerAhead | ||
| Description |
Reorders issue constrainer enablers for an issue constrainer by moving the specified issue constrainer enabler in front of a reference issue constrainer enabler. | ||
| Parameters | osid.id.Id | issueConstrainerEnablerId | the Id of the IssueConstrainerEnabler |
osid.id.Id | issueConstrainerId | the Id of the IssueConstrainer | |
osid.id.Id | referenceId | the reference issue constrainer enabler Id | |
| Errors | NOT_FOUND | issueConstrainerEnablerId issueConstrainerId, or
referenceId not found or, issueConstrainerEnablerId
or referenceId not related to issueConstrainerId | |
| NULL_ARGUMENT | issueConstrainerEnablerId, issueConstrainerId, or
referenceId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | moveIssueConstrainerEnablerBehind | ||
| Description |
Reorders issue constrainer enablers for an issue constrainer by moving the specified issue constrainer enabler behind a reference issue constrainer enabler. | ||
| Parameters | osid.id.Id | issueConstrainerEnablerId | the Id of the IssueConstrainerEnabler |
osid.id.Id | issueConstrainerId | the Id of the IssueConstrainer | |
osid.id.Id | referenceId | the reference issue constrainer Id | |
| Errors | NOT_FOUND | issueConstrainerEnablerId issueConstrainerId, or
referenceId not found or, issueConstrainerEnablerId
or referenceId not related to issueConstrainerId | |
| NULL_ARGUMENT | issueConstrainerEnablerId, issueConstrainerId, or
referenceId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | orderIssueConstrainerEnablers | ||
| Description |
Reorders a set of issue constrainer enablers for an issue constrainer. | ||
| Parameters | osid.id.Id[] | issueConstrainerEnablerIds | the Ids for a set of IssueConstrainerEnablers |
osid.id.Id | issueConstrainerId | the Id of the IssueConstrainer | |
| Errors | NOT_FOUND | issueConstrainerId not found or, an
issueConstrainerEnablerId not related to
issueConstrainerId | |
| NULL_ARGUMENT | issueConstrainerEnablerIds or issueConstrainerId
is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |