public interface QueueProcessorEnablerAdminSession extends OsidSession
This session creates and removes queue processor enablers. The data for
create and update is provided via the QueueProcessorEnablerForm.
Modifier and Type | Method and Description |
---|---|
void |
aliasQueueProcessorEnabler(Id queueProcessorEnablerId,
Id aliasId)
Adds a
Id to a QueueProcessorEnabler for
the purpose of creating compatibility. |
boolean |
canCreateQueueProcessorEnabler()
Tests if this user can create queue processor enablers.
|
boolean |
canCreateQueueProcessorEnablerWithRecordTypes(Type[] queueProcessorEnablerRecordTypes)
Tests if this user can create a single
QueueProcessorEnabler
using the desired record types. |
boolean |
canDeleteQueueProcessorEnablers()
Tests if this user can delete queue processor enablers.
|
boolean |
canManageQueueProcessorEnablerAliases()
Tests if this user can manage
Id aliases for queue
processor enablers. |
boolean |
canUpdateQueueProcessorEnablers()
Tests if this user can update queue processor enablers.
|
QueueProcessorEnabler |
createQueueProcessorEnabler(QueueProcessorEnablerForm queueProcessorEnablerForm)
Creates a new
QueueProcessorEnabler. |
void |
deleteQueueProcessorEnabler(Id queueProcessorEnablerId)
Deletes a
QueueProcessorEnabler. |
FrontOffice |
getFrontOffice()
Gets the
FrontOffice associated with this session. |
Id |
getFrontOfficeId()
Gets the
FrontOffice Id associated with
this session. |
QueueProcessorEnablerForm |
getQueueProcessorEnablerFormForCreate(Type[] queueProcessorEnablerRecordTypes)
Gets the queue processor enabler form for creating new queue processor
enablers.
|
QueueProcessorEnablerForm |
getQueueProcessorEnablerFormForUpdate(Id queueProcessorEnablerId)
Gets the queue processor enabler form for updating an existing queue
processor enabler.
|
void |
updateQueueProcessorEnabler(QueueProcessorEnablerForm queueProcessorEnablerForm)
Updates an existing queue processor enabler.
|
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 canCreateQueueProcessorEnabler()
QueueProcessorEnabler
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 QueueProcessorEnabler
creation is not authorized, true
otherwisemandatory
- This method must be implemented. boolean canCreateQueueProcessorEnablerWithRecordTypes(Type[] queueProcessorEnablerRecordTypes)
QueueProcessorEnabler
using the desired record types. While
TrackingRulesManager.getQueueProcessorEnablerRecordTypes()
can
be used to examine which records are supported, this method tests
which record(s) are required for creating a specific
QueueProcessorEnabler.
Providing an empty array tests if a
QueueProcessorEnabler
can be created with no records.queueProcessorEnablerRecordTypes
- array of queue processor
enabler types true
if QueueProcessorEnabler
creation using the specified record Types
is
supported, false
otherwiseNullArgumentException
-
queueProcessorEnablerRecordTypes
is null
mandatory
- This method must be implemented. QueueProcessorEnablerForm getQueueProcessorEnablerFormForCreate(Type[] queueProcessorEnablerRecordTypes) throws OperationFailedException, PermissionDeniedException
queueProcessorEnablerRecordTypes
- array of queue processor
enabler typesNullArgumentException
-
queueProcessorEnablerRecordTypes
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- unable to get form for requested
record typesmandatory
- This method must be implemented. QueueProcessorEnabler createQueueProcessorEnabler(QueueProcessorEnablerForm queueProcessorEnablerForm) throws OperationFailedException, PermissionDeniedException
QueueProcessorEnabler.
queueProcessorEnablerForm
- the form for this
QueueProcessorEnabler
QueueProcessorEnabler
IllegalStateException
-
queueProcessorEnablerForm
already used in a create
transactionInvalidArgumentException
- one or more of the form
elements is invalidNullArgumentException
-
queueProcessorEnablerForm
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- queueProcessorEnablerForm
did not originate from
getQueueProcessorEnablerFormForCreate()
mandatory
- This method must be implemented. boolean canUpdateQueueProcessorEnablers()
QueueProcessorEnabler
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 QueueProcessorEnabler
modification is not authorized, true
otherwisemandatory
- This method must be implemented. QueueProcessorEnablerForm getQueueProcessorEnablerFormForUpdate(Id queueProcessorEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
queueProcessorEnablerId
- the Id
of the
QueueProcessorEnabler
NotFoundException
- queueProcessorEnablerId
is not foundNullArgumentException
- queueProcessorEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void updateQueueProcessorEnabler(QueueProcessorEnablerForm queueProcessorEnablerForm) throws OperationFailedException, PermissionDeniedException
queueProcessorEnablerForm
- the form containing the elements to
be updatedIllegalStateException
-
queueProcessorEnablerForm
already used in an update
transactionInvalidArgumentException
- the form contains an invalid
valueNullArgumentException
-
queueProcessorEnablerForm
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- queueProcessorEnablerForm
did not originate from
getQueueProcessorEnablerFormForUpdate()
mandatory
- This method must be implemented. boolean canDeleteQueueProcessorEnablers()
QueueProcessorEnabler
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 QueueProcessorEnabler
deletion is not authorized, true
otherwisemandatory
- This method must be implemented. void deleteQueueProcessorEnabler(Id queueProcessorEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
QueueProcessorEnabler.
queueProcessorEnablerId
- the Id
of the
QueueProcessorEnabler
to removeNotFoundException
- queueProcessorEnablerId
not foundNullArgumentException
- queueProcessorEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canManageQueueProcessorEnablerAliases()
Id
aliases for queue
processor enablers. 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 QueueProcessorEnabler
aliasing is not authorized, true
otherwisemandatory
- This method must be implemented. void aliasQueueProcessorEnabler(Id queueProcessorEnablerId, Id aliasId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
Id
to a QueueProcessorEnabler
for
the purpose of creating compatibility. The primary Id
of the QueueProcessorEnabler
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 enabler. it is reassigned to the given queue processor
enabler Id.
queueProcessorEnablerId
- the Id
of a
QueueProcessorEnabler
aliasId
- the alias Id
AlreadyExistsException
- aliasId
is
already assignedNotFoundException
- queueProcessorEnablerId
not foundNullArgumentException
- queueProcessorEnablerId
or aliasId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.