Interface | osid.tracking.IssueFrontOfficeSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session provides methods to retrieve This lookup session defines several views:
| ||
Method | canLookupIssueFrontOfficeMappings | ||
Description |
Tests if this user can perform lookups of issue/front
office 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 | useComparativeIssueFrontOfficeView | ||
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 | usePlenaryIssueFrontOfficeView | ||
Description |
A complete view of the | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getIssueIdsByFrontOffice | ||
Description |
Gets the list of | ||
Parameters | osid.id.Id | frontOfficeId | Id of the FrontOffice |
Return | osid.id.IdList | list of related issue Ids | |
Errors | NOT_FOUND | frontOfficeId is not found | |
NULL_ARGUMENT | frontOfficeId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getIssuesByFrontOffice | ||
Description |
Gets the list of | ||
Parameters | osid.id.Id | frontOfficeId | Id of the FrontOffice |
Return | osid.tracking.IssueList | list of related issues | |
Errors | NOT_FOUND | frontOfficeId is not found | |
NULL_ARGUMENT | frontOfficeId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getIssueIdsByFrontOffices | ||
Description |
Gets the list of | ||
Parameters | osid.id.IdList | frontOfficeIds | list of front office Ids |
Return | osid.id.IdList | list of issue Ids | |
Errors | NULL_ARGUMENT | frontOfficeIds is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getIssuesByFrontOffices | ||
Description |
Gets the list of | ||
Parameters | osid.id.IdList | frontOfficeIds | list of front office Ids |
Return | osid.tracking.IssueList | list of issues | |
Errors | NULL_ARGUMENT | frontOfficeIds is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getFrontOfficeIdsByIssue | ||
Description |
Gets the | ||
Parameters | osid.id.Id | issueId | Id of an Issue |
Return | osid.id.IdList | list of frontOffices | |
Errors | NOT_FOUND | issueId is not found | |
NULL_ARGUMENT | issueId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getFrontOfficesByIssue | ||
Description |
Gets the | ||
Parameters | osid.id.Id | issueId | Id of an Issue |
Return | osid.tracking.FrontOfficeList | list of frontOffices | |
Errors | NOT_FOUND | issueId is not found | |
NULL_ARGUMENT | issueId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |