| Interface | osid.hold.rules.IssueConstrainerOublietteSession | ||
|---|---|---|---|
| Implements | osid.OsidSession | ||
| Used By | osid.hold.rules.HoldRulesManager | ||
osid.hold.rules.HoldRulesProxyManager | |||
| Description |
This session provides methods to retrieve
This lookup session defines several views:
| ||
| Method | canLookupIssueConstrainerOublietteMappings | ||
| Description |
Tests if this user can perform lookups of issue
constrainer/oubliette mappings. A return of true does not
guarantee successful authorization. A return of false
indicates that it is known lookup methods in this session
will result in a | ||
| Return | boolean | false if looking up mappings is not authorized,
true otherwise | |
| Compliance | mandatory | This method must be implemented. | |
| Method | useComparativeIssueConstrainerOublietteView | ||
| Description |
The returns from the lookup methods may omit or translate elements based on this session, such as authorization, and not result in an error. This view is used when greater interoperability is desired at the expense of precision. | ||
| Compliance | mandatory | This method is must be implemented. | |
| Method | usePlenaryIssueConstrainerOublietteView | ||
| Description |
A complete view of the | ||
| Compliance | mandatory | This method is must be implemented. | |
| Method | getIssueConstrainerIdsByOubliette | ||
| Description |
Gets the list of | ||
| Parameters | osid.id.Id | oublietteId | Id of the Oubliette |
| Return | osid.id.IdList | list of related issue constrainer Ids | |
| Errors | NOT_FOUND | oublietteId is not found | |
| NULL_ARGUMENT | oublietteId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getIssueConstrainersByOubliette | ||
| Description |
Gets the list of | ||
| Parameters | osid.id.Id | oublietteId | Id of the Oubliette |
| Return | osid.hold.rules.IssueConstrainerList | list of related issue constrainers | |
| Errors | NOT_FOUND | oublietteId is not found | |
| NULL_ARGUMENT | oublietteId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getIssueConstrainerIdsByOubliettes | ||
| Description |
Gets the list of | ||
| Parameters | osid.id.IdList | oublietteIds | list of oubliette Ids |
| Return | osid.id.IdList | list of issue constrainer Ids | |
| Errors | NULL_ARGUMENT | oublietteIds is null | |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getIssueConstrainersByOubliettes | ||
| Description |
Gets the list of | ||
| Parameters | osid.id.IdList | oublietteIds | list of oubliette Ids |
| Return | osid.hold.rules.IssueConstrainerList | list of issue constrainer Ids | |
| Errors | NULL_ARGUMENT | oublietteIds is null | |
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getOublietteIdsByIssueConstrainer | ||
| Description |
Gets the | ||
| Parameters | osid.id.Id | issueConstrainerId | Id of an IssueConstrainer |
| Return | osid.id.IdList | list of oubliette Ids | |
| Errors | NOT_FOUND | issueConstrainerId is not found | |
| NULL_ARGUMENT | issueConstrainerId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |
| Method | getOubliettesByIssueConstrainer | ||
| Description |
Gets the | ||
| Parameters | osid.id.Id | issueConstrainerId | Id of an IssueConstrainer |
| Return | osid.hold.OublietteList | list of oubliettes | |
| Errors | NOT_FOUND | issueConstrainerId is not found | |
| NULL_ARGUMENT | issueConstrainerId is null | ||
| OPERATION_FAILED | unable to complete request | ||
| PERMISSION_DENIED | authorization failure | ||
| Compliance | mandatory | This method must be implemented. | |