public interface QueueProcessorAdminSession extends OsidSession
This session creates and removes queue processors. The data for create
and update is provided via the QueueProcessorForm.
Modifier and Type | Method and Description |
---|---|
void |
aliasQueueProcessor(Id queueProcessorId,
Id aliasId)
Adds a
Id to a QueueProcessor for the
purpose of creating compatibility. |
boolean |
canCreateQueueProcessor()
Tests if this user can create queue processors.
|
boolean |
canCreateQueueProcessorWithRecordTypes(Type[] queueProcessorRecordTypes)
Tests if this user can create a single
QueueProcessor
using the desired record types. |
boolean |
canDeleteQueueProcessors()
Tests if this user can delete queue processors.
|
boolean |
canManageQueueProcessorAliases()
Tests if this user can manage
Id aliases for queue
processors. |
boolean |
canUpdateQueueProcessors()
Tests if this user can update queue processors.
|
QueueProcessor |
createQueueProcessor(QueueProcessorForm queueProcessorForm)
Creates a new
QueueProcessor. |
void |
deleteQueueProcessor(Id queueProcessorId)
Deletes a
QueueProcessor. |
Distributor |
getDistributor()
Gets the
Distributor associated with this session. |
Id |
getDistributorId()
Gets the
Distributor Id associated with
this session. |
QueueProcessorForm |
getQueueProcessorFormForCreate(Type[] queueProcessorRecordTypes)
Gets the queue processor form for creating new queue processors.
|
QueueProcessorForm |
getQueueProcessorFormForUpdate(Id queueProcessorId)
Gets the queue processor form for updating an existing queue
processor.
|
void |
updateQueueProcessor(QueueProcessorForm queueProcessorForm)
Updates an existing queue processor.
|
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getDistributorId()
Distributor
Id
associated with
this session. Distributor Id
associated with this sessionmandatory
- This method must be implemented. Distributor getDistributor() throws OperationFailedException, PermissionDeniedException
Distributor
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canCreateQueueProcessor()
QueueProcessor
will result
in a PERMISSION_DENIED.
This is intended as a hint to
an application that may opt not to offer create operations to an
unauthorized user. false
if QueueProcessor
creation
is not authorized, true
otherwisemandatory
- This method must be implemented. boolean canCreateQueueProcessorWithRecordTypes(Type[] queueProcessorRecordTypes)
QueueProcessor
using the desired record types. While
ProvisioningRulesManager.getQueueProcessorRecordTypes()
can be
used to examine which records are supported, this method tests which
record(s) are required for creating a specific QueueProcessor.
Providing an empty array tests if a QueueProcessor
can be created with no records.queueProcessorRecordTypes
- array of queue processor record
types true
if QueueProcessor
creation
using the specified record Types
is supported,
false
otherwiseNullArgumentException
-
queueProcessorRecordTypes
is null
mandatory
- This method must be implemented. QueueProcessorForm getQueueProcessorFormForCreate(Type[] queueProcessorRecordTypes) throws OperationFailedException, PermissionDeniedException
queueProcessorRecordTypes
- array of queue processor record
typesNullArgumentException
-
queueProcessorRecordTypes
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- unable to get form for requested
record typesmandatory
- This method must be implemented. QueueProcessor createQueueProcessor(QueueProcessorForm queueProcessorForm) throws OperationFailedException, PermissionDeniedException
QueueProcessor.
queueProcessorForm
- the form for this QueueProcessor
QueueProcessor
IllegalStateException
- queueProcessorForm
already used in a create transactionInvalidArgumentException
- one or more of the form
elements is invalidNullArgumentException
- queueProcessorForm
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- queueProcessorForm
did not originate from
getQueueProcessorFormForCreate()
mandatory
- This method must be implemented. boolean canUpdateQueueProcessors()
QueueProcessor
will result
in a PERMISSION_DENIED.
This is intended as a hint to
an application that may opt not to offer update operations to an
unauthorized user. false
if QueueProcessor
modification is not authorized, true
otherwisemandatory
- This method must be implemented. QueueProcessorForm getQueueProcessorFormForUpdate(Id queueProcessorId) throws NotFoundException, OperationFailedException, PermissionDeniedException
queueProcessorId
- the Id
of the
QueueProcessor
NotFoundException
- queueProcessorId
is
not foundNullArgumentException
- queueProcessorId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void updateQueueProcessor(QueueProcessorForm queueProcessorForm) throws OperationFailedException, PermissionDeniedException
queueProcessorForm
- the form containing the elements to be
updatedIllegalStateException
- queueProcessorForm
already used in an update transactionInvalidArgumentException
- the form contains an invalid
valueNullArgumentException
- queueProcessorForm
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- queueProcessorForm
did not originate from
getQueueProcessorFormForCreate()
mandatory
- This method must be implemented. boolean canDeleteQueueProcessors()
QueueProcessor
will result
in a PERMISSION_DENIED.
This is intended as a hint to
an application that may opt not to offer delete operations to an
unauthorized user. false
if QueueProcessor
deletion
is not authorized, true
otherwisemandatory
- This method must be implemented. void deleteQueueProcessor(Id queueProcessorId) throws NotFoundException, OperationFailedException, PermissionDeniedException
QueueProcessor.
queueProcessorId
- the Id
of the
QueueProcessor
to removeNotFoundException
- queueProcessorId
not
foundNullArgumentException
- queueProcessorId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canManageQueueProcessorAliases()
Id
aliases for queue
processors. A return of true does not guarantee successful
authorization. A return of false indicates that it is known changing
an alias will result in a PERMISSION_DENIED.
This is
intended as a hint to an application that may opt not to offer alias
operations to an unauthorized user. false
if QueueProcessor
aliasing
is not authorized, true
otherwisemandatory
- This method must be implemented. void aliasQueueProcessor(Id queueProcessorId, Id aliasId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
Id
to a QueueProcessor
for the
purpose of creating compatibility. The primary Id
of
the QueueProcessor
is determined by the provider. The
new Id
performs as an alias to the primary Id
. If the alias is a pointer to another queue processor. it is
reassigned to the given queue processor Id.
queueProcessorId
- the Id
of a
QueueProcessor
aliasId
- the alias Id
AlreadyExistsException
- aliasId
is
already assignedNotFoundException
- queueProcessorId
not
foundNullArgumentException
- queueProcessorId
or aliasId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.