Interface QueueResourcingSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface QueueResourcingSession
extends OsidSession

This session defines methods for resourcing queues. A more detailed assignment service can be managed through the Resourcing OSID.

Method Summary

Modifier and Type	Method	Description
void	assignResource(Id queueId, Id resourceId)	Assigns a Resource to a queue.
boolean	canResourceQueue(Id queueId)	Tests if this user can assign Resources to a queue.
boolean	canResourceQueues()	Tests if this user can assign Resources to queues.
FrontOffice	getFrontOffice()	Gets the FrontOffice associated with this session.
Id	getFrontOfficeId()	Gets the FrontOffice Id associated with this session.
ResourceList	getResources(Id queueId)	Gets a list of resource assigned in a queue.
void	unassignResource(Id queueId, Id resourceId)	Unassigns a Resource from 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.

canResourceQueues

boolean canResourceQueues()

Tests if this user can assign Resources to queues. 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.

canResourceQueue

boolean canResourceQueue(Id queueId)

Tests if this user can assign Resources to a queue. 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.

Parameters:

queueId - the Id of a Queue

Returns:

false if resource assignment methods are not authorized, true otherwise

Throws:

NullArgumentException - queueId is null

Compliance:

mandatory - This method must be implemented.

getResources

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

Gets a list of resource assigned in a queue.

Parameters:

queueId - the Id of a Queue

Returns:

a list of resources

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.

assignResource

void assignResource(Id queueId,
 Id resourceId)
             throws AlreadyExistsException,
NotFoundException,
OperationFailedException,
PermissionDeniedException

Assigns a Resource to a queue.

Parameters:

queueId - the Id of a Queue

resourceId - the Id of the Resource

Throws:

AlreadyExistsException - resourceId already assigned to this queue

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.

unassignResource

void unassignResource(Id queueId,
 Id resourceId)
               throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Unassigns a Resource from this queue.

Parameters:

queueId - the Id of a Queue

resourceId - the Id of the Resource

Throws:

NotFoundException - queueId not found or resourceId not assigned to this queue

NullArgumentException - queueId or resourceId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.