Interface IssueTriagingSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface IssueTriagingSession
extends OsidSession

This session defines methods for routing issues.

This lookup session defines several views:

• isolated front office view: All issue methods in this session operate, retrieve and pertain to issues defined explicitly in the current front office. Using an isolated view is useful for managing Issues with the IssueAdminSession .
• federated front office view: All issue lookup methods in this session operate, retrieve and pertain to all issues defined in this front office and any other issues implicitly available in this front office through front office inheritence.

The methods useFederatedFrontOfficeView() and useIsolatedFrontOfficeView() behave as a radio group and one should be selected before invoking any lookup methods.

Method Summary

Modifier and Type	Method	Description
void	assignTopic(Id issueId, Id subjectId)	Assigns a Topic to an Issue .
boolean	canRouteIssues()	Tests if this user can route Issue lookups.
void	closeIssue(Id issueId)	Closes an issue.
IdList	getAssignableTopicIds(Id queueId)	Gets a list of assignable topic Ids for a queue.
SubjectList	getAssignableTopics(Id queueId)	Gets a list of assignable topics for a queue.
FrontOffice	getFrontOffice()	Gets the FrontOffice associated with this session.
Id	getFrontOfficeId()	Gets the FrontOffice Id associated with this session.
void	moveIssueToQueue(Id issueId, Id queueId)	Moves an Issue to another Queue .
void	useFederatedFrontOfficeView()	Federates the view for methods in this session.
void	useIsolatedFrontOfficeView()	Isolates the view for methods in this session.

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.

canRouteIssues

boolean canRouteIssues()

Tests if this user can route 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 routing operations to unauthorized users.

Returns:

false if routing methods are not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

useFederatedFrontOfficeView

void useFederatedFrontOfficeView()

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.

useIsolatedFrontOfficeView

void useIsolatedFrontOfficeView()

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.

moveIssueToQueue

void moveIssueToQueue(Id issueId,
 Id queueId)
               throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Moves an Issue to another Queue . If the assigned resource is not valid in the destination queue, the issue may automatically be unassigned. If the assigned topic is not valid in the destination queue, it may default to another topic.

Parameters:

issueId - the Id of the Issue

queueId - the Id of the Queue

Throws:

AlreadyExistsException - issueId already in queueId

NotFoundException - issueId or queueId not found

NullArgumentException - issueId or queueId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getAssignableTopicIds

IdList getAssignableTopicIds(Id queueId)
                      throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets a list of assignable topic Ids for a queue.

Parameters:

queueId - the Id of the Queue

Returns:

a list of subject Ids

Throws:

NotFoundException - queueId not found

NullArgumentException - queueId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getAssignableTopics

SubjectList getAssignableTopics(Id queueId)
                         throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets a list of assignable topics for a queue.

Parameters:

queueId - the Id of the Queue

Returns:

a list of subjects

Throws:

NotFoundException - queueId not found

NullArgumentException - queueId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

assignTopic

void assignTopic(Id issueId,
 Id subjectId)
          throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Assigns a Topic to an Issue .

Parameters:

issueId - the Id of the Issue

subjectId - the Id of the Subject

Throws:

AlreadyExistsException - issueId already assigned to subjectId

NotFoundException - issueId or subjectId not found

NullArgumentException - issueId or subjectId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

closeIssue

void closeIssue(Id issueId)
         throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Closes an issue.

Parameters:

issueId - the Id of the Issue

Throws:

NotFoundException - issueId not found

NullArgumentException - issueId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.