Interface | osid.tracking.IssueTrackingSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session defines methods for looking at issues in a queue. 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 | getIssue | ||
Description |
Gets the | ||
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 in this queue 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 | getOpenIssues | ||
Description |
Gets a list of all open issues in a queue. | ||
Parameters | osid.id.Id | queueId | the Id of a Queue to |
Return | osid.tracking.IssueList | the returned Issue list | |
Errors | NOT_FOUND | queueId is not found | |
NULL_ARGUMENT | queueId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getOpenUnassignedIssues | ||
Description |
Gets a list of all open unassigned issues in this queue. | ||
Parameters | osid.id.Id | queueId | the Id of a Queue to |
Return | osid.tracking.IssueList | the returned Issue list | |
Errors | NOT_FOUND | queueId is not found | |
NULL_ARGUMENT | queueId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getOpenIdleIssues | ||
Description |
Gets a list of open issues that have been idle since the given date. | ||
Parameters | osid.id.Id | queueId | the Id of a Queue to |
osid.calendaring.DateTime | date | a date | |
Return | osid.tracking.IssueList | the returned IssueList | |
Errors | NOT_FOUND | queueId is not found | |
NULL_ARGUMENT | queueId or date is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getOpenIssuesByAssignee | ||
Description |
Gets a list of open issues assigned to the given resource. | ||
Parameters | osid.id.Id | queueId | the Id of a Queue to |
osid.id.Id | resourceId | a resource | |
Return | osid.tracking.IssueList | the returned IssueList | |
Errors | NOT_FOUND | queueId is not found | |
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 | getOpenIssuesByTopic | ||
Description |
Gets a list of issues by topic which may include issues of any child topic. | ||
Parameters | osid.id.Id | queueId | the Id of a Queue to |
osid.id.Id | subjectId | a resource | |
Return | osid.tracking.IssueList | the returned IssueList | |
Errors | NOT_FOUND | queueId is not found | |
NULL_ARGUMENT | queueId or subjectId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getClosedIssues | ||
Description |
Gets a list of all closed issues in this queue. | ||
Parameters | osid.id.Id | queueId | the Id of a Queue to |
Return | osid.tracking.IssueList | the returned Issue list | |
Errors | NOT_FOUND | queueId is not found | |
NULL_ARGUMENT | queueId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getClosedIssuesByAssignee | ||
Description |
Gets a list of closed issues that were ever assigned to the given resource. | ||
Parameters | osid.id.Id | queueId | the Id of a Queue to |
osid.id.Id | resourceId | a resource | |
Return | osid.tracking.IssueList | the returned IssueList | |
Errors | NOT_FOUND | queueId is not found | |
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 | getClosedIssuesByTopic | ||
Description |
Gets a list of issues by topic which may include issues of any child topic. | ||
Parameters | osid.id.Id | queueId | the Id of a Queue to |
osid.id.Id | topicId | a resource | |
Return | osid.tracking.IssueList | the returned IssueList | |
Errors | NOT_FOUND | queueId is not found | |
NULL_ARGUMENT | queueId or topicId is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getClosedIssuesByCreateDate | ||
Description |
Gets a list of closed issues that were created between the given date range inclusive. | ||
Parameters | osid.id.Id | queueId | the Id of a Queue to |
osid.calendaring.DateTime | from | start of date range | |
osid.calendaring.DateTime | to | end of date range | |
Return | osid.tracking.IssueList | the returned IssueList | |
Errors | INVALID_ARGUMENT | from is greater than to | |
NOT_FOUND | queueId is not found | ||
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 | getIssuesByActiveDate | ||
Description |
Gets a list of all issues that were in an open status on the given date. | ||
Parameters | osid.id.Id | queueId | the Id of a Queue to |
osid.calendaring.DateTime | date | a date | |
Return | osid.tracking.IssueList | the returned IssueList | |
Errors | NOT_FOUND | queueId is not found | |
NULL_ARGUMENT | queueId or date is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getIssuesSinceDate | ||
Description |
Gets a list of all issues created since the given date. | ||
Parameters | osid.id.Id | queueId | the Id of a Queue to |
osid.calendaring.DateTime | date | a date | |
Return | osid.tracking.IssueList | the returned IssueList | |
Errors | NOT_FOUND | queueId is not found | |
NULL_ARGUMENT | queueId or date is null | ||
OPERATION_FAILED | unable to complete request | ||
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. |