public interface QueueConstrainerEnablerAdminSession extends OsidSession
This session creates and removes queue constrainer enablers. The data
for create and update is provided via the
QueueConstrainerEnablerForm.
Modifier and Type | Method and Description |
---|---|
void |
aliasQueueConstrainerEnabler(Id queueConstrainerEnablerId,
Id aliasId)
Adds a
Id to a QueueConstrainerEnabler
for the purpose of creating compatibility. |
boolean |
canCreateQueueConstrainerEnabler()
Tests if this user can create queue constrainer enablers.
|
boolean |
canCreateQueueConstrainerEnablerWithRecordTypes(Type[] queueConstrainerEnablerRecordTypes)
Tests if this user can create a single
QueueConstrainerEnabler
using the desired record types. |
boolean |
canDeleteQueueConstrainerEnablers()
Tests if this user can delete queue constrainer enablers.
|
boolean |
canManageQueueConstrainerEnablerAliases()
Tests if this user can manage
Id aliases for queue
constrainer enablers. |
boolean |
canUpdateQueueConstrainerEnablers()
Tests if this user can update queue constrainer enablers.
|
QueueConstrainerEnabler |
createQueueConstrainerEnabler(QueueConstrainerEnablerForm queueConstrainerEnablerForm)
Creates a new
QueueConstrainerEnabler. |
void |
deleteQueueConstrainerEnabler(Id queueConstrainerEnablerId)
Deletes a
QueueConstrainerEnabler. |
Distributor |
getDistributor()
Gets the
Distributor associated with this session. |
Id |
getDistributorId()
Gets the
Distributor Id associated with
this session. |
QueueConstrainerEnablerForm |
getQueueConstrainerEnablerFormForCreate()
Gets the queue constrainer enabler form for creating new queue
constrainer enablers.
|
QueueConstrainerEnablerForm |
getQueueConstrainerEnablerFormForUpdate(Id queueConstrainerEnablerId)
Gets the queue constrainer enabler form for updating an existing queue
constrainer enabler.
|
void |
updateQueueConstrainerEnabler(QueueConstrainerEnablerForm queueConstrainerEnablerForm)
Updates an existing queue constrainer enabler.
|
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 canCreateQueueConstrainerEnabler()
QueueConstrainerEnabler
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 QueueConstrainerEnabler
creation is not authorized, true
otherwisemandatory
- This method must be implemented. boolean canCreateQueueConstrainerEnablerWithRecordTypes(Type[] queueConstrainerEnablerRecordTypes)
QueueConstrainerEnabler
using the desired record types. While
ProvisioningRulesManager.getQueueConstrainerEnablerRecordTypes()
can be used to examine which records are supported, this
method tests which record(s) are required for creating a specific
QueueConstrainerEnabler.
Providing an empty array tests
if a QueueConstrainerEnabler
can be created with no
records.queueConstrainerEnablerRecordTypes
- array of types true
if QueueConstrainerEnabler
creation using the specified record Types
is
supported, false
otherwiseNullArgumentException
-
queueConstrainerEnablerRecordTypes
is null
mandatory
- This method must be implemented. QueueConstrainerEnablerForm getQueueConstrainerEnablerFormForCreate() throws OperationFailedException, PermissionDeniedException
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. QueueConstrainerEnabler createQueueConstrainerEnabler(QueueConstrainerEnablerForm queueConstrainerEnablerForm) throws OperationFailedException, PermissionDeniedException
QueueConstrainerEnabler.
queueConstrainerEnablerForm
- the form for this
QueueConstrainerEnabler
QueueConstrainerEnabler
IllegalStateException
-
queueConstrainerEnablerForm
already used in a create
transactionInvalidArgumentException
- one or more of the form
elements is invalidNullArgumentException
-
queueConstrainerEnablerForm
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
-
queueConstrainerEnablerForm
did not originate from
getQueueConstrainerEnablerFormForCreate()
mandatory
- This method must be implemented. boolean canUpdateQueueConstrainerEnablers()
QueueConstrainerEnabler
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 QueueConstrainerEnabler
modification is not authorized, true
otherwisemandatory
- This method must be implemented. QueueConstrainerEnablerForm getQueueConstrainerEnablerFormForUpdate(Id queueConstrainerEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
queueConstrainerEnablerId
- the Id
of the
QueueConstrainerEnabler
NotFoundException
- queueConstrainerEnablerId
is not foundNullArgumentException
-
queueConstrainerEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void updateQueueConstrainerEnabler(QueueConstrainerEnablerForm queueConstrainerEnablerForm) throws OperationFailedException, PermissionDeniedException
queueConstrainerEnablerForm
- the form containing the elements
to be updatedIllegalStateException
-
queueConstrainerEnablerForm
already used in an update
transactionInvalidArgumentException
- the form contains an invalid
valueNullArgumentException
-
queueConstrainerEnablerForm
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
-
queueConstrainerEnablerForm
did not originate from
getQueueConstrainerEnablerFormForUpdate()
mandatory
- This method must be implemented. boolean canDeleteQueueConstrainerEnablers()
QueueConstrainerEnabler
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 QueueConstrainerEnabler
deletion is not authorized, true
otherwisemandatory
- This method must be implemented. void deleteQueueConstrainerEnabler(Id queueConstrainerEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
QueueConstrainerEnabler.
queueConstrainerEnablerId
- the Id
of the
QueueConstrainerEnabler
to removeNotFoundException
- queueConstrainerEnablerId
not foundNullArgumentException
-
queueConstrainerEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canManageQueueConstrainerEnablerAliases()
Id
aliases for queue
constrainer 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 QueueConstrainerEnabler
aliasing is not authorized, true
otherwisemandatory
- This method must be implemented. void aliasQueueConstrainerEnabler(Id queueConstrainerEnablerId, Id aliasId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
Id
to a QueueConstrainerEnabler
for the purpose of creating compatibility. The primary Id
of the QueueConstrainerEnabler
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
constrainer enabler. it is reassigned to the given queue constrainer
enabler Id.
queueConstrainerEnablerId
- the Id
of a
QueueConstrainerEnabler
aliasId
- the alias Id
AlreadyExistsException
- aliasId
is
already assignedNotFoundException
- queueConstrainerEnablerId
not foundNullArgumentException
-
queueConstrainerEnablerId
or aliasId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.