Interface IssueTrackingSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface IssueTrackingSession
extends OsidSession

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 Issues .

Method Summary

Modifier and Type	Method	Description
boolean	canLookupIssues()	Tests if this user can perform Issue lookups.
IssueList	getClosedIssues(Id queueId)	Gets a list of all closed issues in this queue.
IssueList	getClosedIssuesByAssignee(Id queueId, Id resourceId)	Gets a list of closed issues that were ever assigned to the given resource.
IssueList	getClosedIssuesByCreateDate(Id queueId, DateTime from, DateTime to)	Gets a list of closed issues that were created between the given date range inclusive.
IssueList	getClosedIssuesByTopic(Id queueId, Id topicId)	Gets a list of issues by topic which may include issues of any child topic.
FrontOffice	getFrontOffice()	Gets the FrontOffice associated with this session.
Id	getFrontOfficeId()	Gets the FrontOffice Id associated with this session.
Issue	getIssue(Id issueId)	Gets the Issue specified by its Id .
IssueList	getIssuesByActiveDate(Id queueId, DateTime date)	Gets a list of all issues that were in an open status on the given date.
IssueList	getIssuesSinceDate(Id queueId, DateTime date)	Gets a list of all issues created since the given date.
IssueList	getOpenIdleIssues(Id queueId, DateTime date)	Gets a list of open issues that have been idle since the given date.
IssueList	getOpenIssues(Id queueId)	Gets a list of all open issues in a queue.
IssueList	getOpenIssuesByAssignee(Id queueId, Id resourceId)	Gets a list of open issues assigned to the given resource.
IssueList	getOpenIssuesByTopic(Id queueId, Id subjectId)	Gets a list of issues by topic which may include issues of any child topic.
IssueList	getOpenUnassignedIssues(Id queueId)	Gets a list of all open unassigned issues in this queue.

Methods inherited from interface Closeable

close

Methods inherited from interface OsidSession

close

Modifier and Type	Method	Description
void	close()	Close this session.

Methods inherited from interface OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Modifier and Type	Method	Description
Agent	getAuthenticatedAgent()	Gets the agent authenticated to this session.
Id	getAuthenticatedAgentId()	Gets the Id of the agent authenticated to this session.
BigDecimal	getClockRate()	Gets the rate of the service clock.
Date	getDate()	Gets the service date which may be the current date or the effective date in which this session exists.
Agent	getEffectiveAgent()	Gets the effective agent in use by this session.
Id	getEffectiveAgentId()	Gets the Id of the effective agent in use by this session.
Type	getFormatType()	Gets the DisplayText format Type preference in effect for this session.
Locale	getLocale()	Gets the locale indicating the localization preferences in effect for this session.
boolean	isAuthenticated()	Tests if an agent is authenticated to this session.
Transaction	startTransaction()	Starts a new transaction for this sesson.
boolean	supportsTransactions()	Tests for the availability of transactions.

Method Details

getFrontOfficeId

Id getFrontOfficeId()

Gets the FrontOffice Id associated with this session.

Returns:

the FrontOffice Id associated with this session

Compliance:

mandatory - This method must be implemented.

getFrontOffice

FrontOffice getFrontOffice()
                    throws OperationFailedException,
PermissionDeniedException

Gets the FrontOffice associated with this session.

Returns:

the front office

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canLookupIssues

boolean canLookupIssues()

Tests if this user can perform Issue lookups. A return of true does not guarantee successful authorization. A return of false indicates that it is known all methods in this session will result in a PERMISSION_DENIED . This is intended as a hint to an application that may not offer lookup operations to unauthorized users.

Returns:

false if lookup methods are not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

getIssue

Issue getIssue(Id issueId)
        throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the Issue specified by its Id .

Parameters:

issueId - the Id of the Issue to retrieve

Returns:

the returned Issue

Throws:

NotFoundException - no Issue found in this queue with the given Id

NullArgumentException - issueId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getOpenIssues

IssueList getOpenIssues(Id queueId)
                 throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets a list of all open issues in a queue.

Parameters:

queueId - the Id of a Queue to

Returns:

the returned Issue list

Throws:

NotFoundException - queueId is not found

NullArgumentException - queueId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getOpenUnassignedIssues

IssueList getOpenUnassignedIssues(Id queueId)
                           throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets a list of all open unassigned issues in this queue.

Parameters:

queueId - the Id of a Queue to

Returns:

the returned Issue list

Throws:

NotFoundException - queueId is not found

NullArgumentException - queueId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getOpenIdleIssues

IssueList getOpenIdleIssues(Id queueId,
 DateTime date)
                     throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets a list of open issues that have been idle since the given date.

Parameters:

queueId - the Id of a Queue to

date - a date

Returns:

the returned IssueList

Throws:

NotFoundException - queueId is not found

NullArgumentException - queueId or date is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getOpenIssuesByAssignee

IssueList getOpenIssuesByAssignee(Id queueId,
 Id resourceId)
                           throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets a list of open issues assigned to the given resource.

Parameters:

queueId - the Id of a Queue to

resourceId - a resource

Returns:

the returned IssueList

Throws:

NotFoundException - queueId is not found

NullArgumentException - queueId or resourceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getOpenIssuesByTopic

IssueList getOpenIssuesByTopic(Id queueId,
 Id subjectId)
                        throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets a list of issues by topic which may include issues of any child topic.

Parameters:

queueId - the Id of a Queue to

subjectId - a resource

Returns:

the returned IssueList

Throws:

NotFoundException - queueId is not found

NullArgumentException - queueId or subjectId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getClosedIssues

IssueList getClosedIssues(Id queueId)
                   throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets a list of all closed issues in this queue.

Parameters:

queueId - the Id of a Queue to

Returns:

the returned Issue list

Throws:

NotFoundException - queueId is not found

NullArgumentException - queueId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getClosedIssuesByAssignee

IssueList getClosedIssuesByAssignee(Id queueId,
 Id resourceId)
                             throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets a list of closed issues that were ever assigned to the given resource.

Parameters:

queueId - the Id of a Queue to

resourceId - a resource

Returns:

the returned IssueList

Throws:

NotFoundException - queueId is not found

NullArgumentException - queueId or resourceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getClosedIssuesByTopic

IssueList getClosedIssuesByTopic(Id queueId,
 Id topicId)
                          throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets a list of issues by topic which may include issues of any child topic.

Parameters:

queueId - the Id of a Queue to

topicId - a resource

Returns:

the returned IssueList

Throws:

NotFoundException - queueId is not found

NullArgumentException - queueId or topicId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getClosedIssuesByCreateDate

IssueList getClosedIssuesByCreateDate(Id queueId,
 DateTime from,
 DateTime to)
                               throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets a list of closed issues that were created between the given date range inclusive.

Parameters:

queueId - the Id of a Queue to

from - start of date range

to - end of date range

Returns:

the returned IssueList

Throws:

InvalidArgumentException - from is greater than to

NotFoundException - queueId is not found

NullArgumentException - queueId, from or to is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getIssuesByActiveDate

IssueList getIssuesByActiveDate(Id queueId,
 DateTime date)
                         throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets a list of all issues that were in an open status on the given date.

Parameters:

queueId - the Id of a Queue to

date - a date

Returns:

the returned IssueList

Throws:

NotFoundException - queueId is not found

NullArgumentException - queueId or date is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getIssuesSinceDate

IssueList getIssuesSinceDate(Id queueId,
 DateTime date)
                      throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets a list of all issues created since the given date.

Parameters:

queueId - the Id of a Queue to

date - a date

Returns:

the returned IssueList

Throws:

NotFoundException - queueId is not found

NullArgumentException - queueId or date is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.