Interface | osid.tracking.BlockingIssueLookupSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session defines methods for retrieving blocking issues. This lookup session defines several views:
The methods Issues may have an additional records indicated by their
respective record types. The record may not be accessed
through a cast of the | ||
Method | getFrontOfficeId | ||
Description |
Gets the | ||
Return | osid.id.Id | the FrontOffice Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getFrontOffice | ||
Description |
Gets the | ||
Return | osid.tracking.FrontOffice | the front office | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | canLookupBlockingIssues | ||
Description |
Tests if this user can perform blocking | ||
Return | boolean | false if lookup methods are not authorized, true
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | useComparativeIssueView | ||
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 | usePlenaryIssueView | ||
Description |
A complete view of the | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useFederatedFrontOfficeView | ||
Description |
Federates the view for methods in this session. A federated view will include issues in front offices which are children of this front office in the front office hierarchy. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useIsolatedFrontOfficeView | ||
Description |
Isolates the view for methods in this session. An isolated view restricts retrievals to this front office only. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getBlockingIssueIds | ||
Description |
Gets any blocking issues of the given | ||
Parameters | osid.id.Id | issueId | the Id of the Issue |
Return | osid.id.IdList | the returned blocking issue Ids | |
Errors | NOT_FOUND | no Issue found with the given Id | |
NULL_ARGUMENT | issueId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getBlockingIssues | ||
Description |
Gets any blocking issues of the given | ||
Parameters | osid.id.Id | issueId | the Id of the Issue |
Return | osid.tracking.IssueList | the returned blocking issues | |
Errors | NOT_FOUND | no Issue found with the given Id | |
NULL_ARGUMENT | issueId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getBlockedIssueIds | ||
Description |
Gets any blocked issues as a result of the given | ||
Parameters | osid.id.Id | blockingIssueId | the Id of the blocking Issue |
Return | osid.id.IdList | the returned blocked issue Ids | |
Errors | NOT_FOUND | no Issue found with the given Id | |
NULL_ARGUMENT | blockingIssueId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getBlockedIssues | ||
Description |
Gets any blocked issues as a result of the given | ||
Parameters | osid.id.Id | blockingIssueId | the Id of the blocking Issue |
Return | osid.tracking.IssueList | the returned blocked issues | |
Errors | NOT_FOUND | no Issue found with the given Id | |
NULL_ARGUMENT | blockingIssueId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |