Interface | osid.tracking.IssueLookupSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session defines methods for retrieving 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 | canLookupIssues | ||
Description |
Tests if this user can perform | ||
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 | useEffectiveIssueView | ||
Description |
Only issues whose effective dates are current are returned by methods in this session. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | useAnyEffectiveIssueView | ||
Description |
All issues of any effective dates are returned by methods in this session. | ||
Compliance | mandatory | This method is must be implemented. | |
Method | getIssue | ||
Description |
Gets the In effective mode, issues are returned that are currently effective. In any effective mode, effective issues and those currently expired are returned. | ||
Parameters | osid.id.Id | issueId | the Id of the Issue to retrieve |
Return | osid.tracking.Issue | the returned Issue | |
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 | getIssuesByIds | ||
Description |
Gets an In effective mode, issues are returned that are currently effective. In any effective mode, effective issues and those currently expired are returned. | ||
Parameters | osid.id.IdList | issueIds | the list of Ids to retrieve |
Return | osid.tracking.IssueList | the returned Issue list | |
Errors | NOT_FOUND | an Id was not found | |
NULL_ARGUMENT | issueIds is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getIssuesByGenusType | ||
Description |
Gets an In effective mode, issues are returned that are currently effective. In any effective mode, effective issues and those currently expired are returned. | ||
Parameters | osid.type.Type | issueGenusType | an issue genus type |
Return | osid.tracking.IssueList | the returned Issue list | |
Errors | NULL_ARGUMENT | issueGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getIssuesByParentGenusType | ||
Description |
Gets an In effective mode, issues are returned that are currently effective. In any effective mode, effective issues and those currently expired are returned. | ||
Parameters | osid.type.Type | issueGenusType | an issue genus type |
Return | osid.tracking.IssueList | the returned Issue list | |
Errors | NULL_ARGUMENT | issueGenusType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getIssuesByRecordType | ||
Description |
Gets an In plenary mode, the returned list contains all known issues or an error results. Otherwise, the returned list may contain only those issues that are accessible through this session. In effective mode, issues are returned that are currently effective. In any effective mode, effective issues and those currently expired are returned. | ||
Parameters | osid.type.Type | issueRecordType | an issue record type |
Return | osid.tracking.IssueList | the returned Issue list | |
Errors | NULL_ARGUMENT | issueRecordType is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getIssuesOnDate | ||
Description |
Gets a list of issues effective beginning in the date range. Issues are returned with a start effective date that falls between the requested dates inclusive. In plenary mode, the returned list contains all known issues or an error results. Otherwise, the returned list may contain only those issues that are accessible through this session. In effective mode, issues are returned that are currently effective in addition to being effective in the given date range. In any effective mode, effective issues and those currently expired are returned. | ||
Parameters | osid.calendaring.DateTime | from | start of date range |
osid.calendaring.DateTime | to | end of date range | |
Return | osid.tracking.IssueList | the returned Issue list | |
Errors | INVALID_ARGUMENT | from is greater than to | |
NULL_ARGUMENT | from or to is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getIssuesForQueue | ||
Description |
Gets a list of issues by queue. In effective mode, issues are returned that are currently effective. In any effective mode, effective issues and those currently expired are returned. | ||
Parameters | osid.id.Id | queueId | a queue Id |
Return | osid.tracking.IssueList | the returned Issue list | |
Errors | NULL_ARGUMENT | queueId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getIssuesForQueueOnDate | ||
Description |
Gets a list of issues for a queue effective beginning
in the date range. Issues are returned with a start
effective date that falls between the requested dates
inclusive. In effective mode, issues are returned that are currently effective in addition to being effective in the given date range. In any effective mode, effective issues and those currently expired are returned. | ||
Parameters | osid.id.Id | queueId | a queue Id |
osid.calendaring.DateTime | from | start of date range | |
osid.calendaring.DateTime | to | end of date range | |
Return | osid.tracking.IssueList | the returned Issue list | |
Errors | INVALID_ARGUMENT | from is greater than to | |
NULL_ARGUMENT | queueId, from, or to is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getIssuesForCustomer | ||
Description |
Gets a list of issues by customer. In effective mode, issues are returned that are currently effective. In any effective mode, effective issues and those currently expired are returned. | ||
Parameters | osid.id.Id | resourceId | a resource Id |
Return | osid.tracking.IssueList | the returned Issue list | |
Errors | NULL_ARGUMENT | resourceId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getIssuesForCustomerOnDate | ||
Description |
Gets a list of issues for a customer effective
beginning in the date range. Issues are returned with a
start effective date that falls between the requested
dates inclusive. In effective mode, issues are returned that are currently effective in addition to being effective in the given date range. In any effective mode, effective issues and those currently expired are returned. | ||
Parameters | osid.id.Id | resourceId | a resource Id |
osid.calendaring.DateTime | from | start of date range | |
osid.calendaring.DateTime | to | end of date range | |
Return | osid.tracking.IssueList | the returned Issue list | |
Errors | INVALID_ARGUMENT | from is greater than to | |
NULL_ARGUMENT | resourceId, from, or to is null
| ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getIssuesForQueueAndCustomer | ||
Description |
Gets a list of issues by queue and customer. In effective mode, issues are returned that are currently effective. In any effective mode, effective issues and those currently expired are returned. | ||
Parameters | osid.id.Id | queueId | a queue Id |
osid.id.Id | resourceId | a resource Id | |
Return | osid.tracking.IssueList | the returned Issue list | |
Errors | NULL_ARGUMENT | queueId or resourceId is null | |
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getIssuesForQueueAndCustomerOnDate | ||
Description |
Gets a list of issues for a queue and customer
effective beginning in the date range. Issues are returned
with a start effective date that falls between the
requested dates inclusive. In effective mode, issues are returned that are currently effective in addition to being effective in the given date range. In any effective mode, effective issues and those currently expired are returned. | ||
Parameters | osid.id.Id | queueId | a queue Id |
osid.id.Id | resourceId | a resource Id | |
osid.calendaring.DateTime | from | start of date range | |
osid.calendaring.DateTime | to | end of date range | |
Return | osid.tracking.IssueList | the returned Issue list | |
Errors | INVALID_ARGUMENT | from is greater than to | |
NULL_ARGUMENT | queueId, resourceId, from, or to is
null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getIssues | ||
Description |
Gets all issues. In effective mode, issues are returned that are currently effective. In any effective mode, effective issues and those currently expired are returned. | ||
Return | osid.tracking.IssueList | the returned Issue list | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |