public interface QueueResourcingSession extends OsidSession
This session defines methods for resourcing queues. A more detailed assignment service can be managed through the Resourcing OSID.
Modifier and Type | Method and 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. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getFrontOfficeId()
FrontOffice
Id
associated with
this session. FrontOffice Id
associated with this sessionmandatory
- This method must be implemented. FrontOffice getFrontOffice() throws OperationFailedException, PermissionDeniedException
FrontOffice
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canResourceQueues()
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. false
if resource assignment methods are not
authorized, true
otherwisemandatory
- This method must be implemented. boolean canResourceQueue(Id queueId)
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.queueId
- the Id
of a Queue
false
if resource assignment methods are not
authorized, true
otherwiseNullArgumentException
- queueId
is
null
mandatory
- This method must be implemented. ResourceList getResources(Id queueId) throws NotFoundException, OperationFailedException, PermissionDeniedException
queueId
- the Id
of a Queue
NotFoundException
- queueId
is not foundNullArgumentException
- queueId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void assignResource(Id queueId, Id resourceId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
Resource
to a queue.queueId
- the Id
of a Queue
resourceId
- the Id
of the Resource
AlreadyExistsException
- resourceId
already assigned to this queueNotFoundException
- queueId
or
resourceId
not foundNullArgumentException
- queueId
or
resourceId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void unassignResource(Id queueId, Id resourceId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Resource
from this queue.queueId
- the Id
of a Queue
resourceId
- the Id
of the Resource
NotFoundException
- queueId
not found or
resourceId
not assigned to this queueNullArgumentException
- queueId
or
resourceId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.