Interface IssueResourcingSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface IssueResourcingSession
extends OsidSession

This session defines methods for resourcing issues.

Method Summary

Modifier and Type	Method	Description
void	assignIssueToResource(Id issueId, Id resourceId)	Assigns an Issue to a Resource .
boolean	canResourceIssues()	Tests if this user can assign resources to Issues .
FrontOffice	getFrontOffice()	Gets the FrontOffice associated with this session.
Id	getFrontOfficeId()	Gets the FrontOffice Id associated with this session.
IssueList	getIssuesByResource(Id resourceId)	Gets a list of issues assigned to a resource.
IssueList	getIssuesByResourceForQueue(Id queueId, Id resourceId)	Gets a list of issues assigned to a resource in a given queue.
ResourceList	getResourcesAvailableForIssue(Id issueId)	Gets a list of candidate resources from this queue available for an issue sorted from best suited.
ResourceList	getResourcesForQueue(Id queueId)	Gets a list of resource assignable in this queue.
void	unassignIssueFromResource(Id issueId)	Unassigns an Issue from a Resource .

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.

canResourceIssues

boolean canResourceIssues()

Tests if this user can assign resources to Issues . 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 assignment operations to unauthorized users.

Returns:

false if resource assignment methods are not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

getResourcesForQueue

ResourceList getResourcesForQueue(Id queueId)
                           throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets a list of resource assignable in this queue.

Parameters:

queueId - the Id of a Queue

Returns:

a list of resources

Throws:

NotFoundException - queueId not found

NullArgumentException - queueId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getResourcesAvailableForIssue

ResourceList getResourcesAvailableForIssue(Id issueId)
                                    throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets a list of candidate resources from this queue available for an issue sorted from best suited.

Parameters:

issueId - the Id of an Issue

Returns:

a list of resources

Throws:

NotFoundException - issueId not found

NullArgumentException - issueId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getIssuesByResource

IssueList getIssuesByResource(Id resourceId)
                       throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets a list of issues assigned to a resource.

Parameters:

resourceId - the Id of a Resource

Returns:

a list of issues

Throws:

NotFoundException - resourceId not found

NullArgumentException - resourceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getIssuesByResourceForQueue

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

Gets a list of issues assigned to a resource in a given queue.

Parameters:

queueId - the Id of a Queue

resourceId - the Id of a Resource

Returns:

a list of issues

Throws:

NotFoundException - queueId or resourceId not found

NullArgumentException - queueId or resourceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

assignIssueToResource

void assignIssueToResource(Id issueId,
 Id resourceId)
                    throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Assigns an Issue to a Resource . The resource must be a valid resource in the issue queue.

Parameters:

issueId - the Id of the Issue

resourceId - the Id of the Resource

Throws:

AlreadyExistsException - issueId already assigned

NotFoundException - issueId or resourceId not found

NullArgumentException - issueId or resourceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

unassignIssueFromResource

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

Unassigns an Issue from a Resource .

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.