public interface QueueConstrainerAdminSession extends OsidSession
This session creates and removes queue constrainers. The data for
create and update is provided via the QueueConstrainerForm.
Modifier and Type | Method and Description |
---|---|
void |
aliasQueueConstrainer(Id queueConstrainerId,
Id aliasId)
Adds a
Id to a QueueConstrainer for the
purpose of creating compatibility. |
boolean |
canCreateQueueConstrainer()
Tests if this user can create queue constrainers.
|
boolean |
canCreateQueueConstrainerWithRecordTypes(Type[] queueConstrainerRecordTypes)
Tests if this user can create a single
QueueConstrainer
using the desired record types. |
boolean |
canDeleteQueueConstrainers()
Tests if this user can delete queue constrainers.
|
boolean |
canManageQueueConstrainerAliases()
Tests if this user can manage
Id aliases for queue
constrainers. |
boolean |
canUpdateQueueConstrainers()
Tests if this user can update queue constrainers.
|
QueueConstrainer |
createQueueConstrainer(QueueConstrainerForm queueConstrainerForm)
Creates a new
QueueConstrainer. |
void |
deleteQueueConstrainer(Id queueConstrainerId)
Deletes a
QueueConstrainer. |
Distributor |
getDistributor()
Gets the
Distributor associated with this session. |
Id |
getDistributorId()
Gets the
Distributor Id associated with
this session. |
QueueConstrainerForm |
getQueueConstrainerFormForCreate(Type[] queueConstrainerRecordTypes)
Gets the queue constrainer form for creating new queue constrainers.
|
QueueConstrainerForm |
getQueueConstrainerFormForUpdate(Id queueConstrainerId)
Gets the queue constrainer form for updating an existing queue
constrainer.
|
void |
updateQueueConstrainer(QueueConstrainerForm queueConstrainerForm)
Updates an existing queue constrainer.
|
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 canCreateQueueConstrainer()
QueueConstrainer
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 QueueConstrainer
creation is not authorized, true
otherwisemandatory
- This method must be implemented. boolean canCreateQueueConstrainerWithRecordTypes(Type[] queueConstrainerRecordTypes)
QueueConstrainer
using the desired record types. While
ProvisioningRulesManager.getQueueConstrainerRecordTypes()
can
be used to examine which records are supported, this method tests
which record(s) are required for creating a specific
QueueConstrainer.
Providing an empty array tests if a
QueueConstrainer
can be created with no records.queueConstrainerRecordTypes
- array of queue constrainer record
types true
if QueueConstrainer
creation using the specified record Types
is
supported, false
otherwiseNullArgumentException
-
queueConstrainerRecordTypes
is null
mandatory
- This method must be implemented. QueueConstrainerForm getQueueConstrainerFormForCreate(Type[] queueConstrainerRecordTypes) throws OperationFailedException, PermissionDeniedException
queueConstrainerRecordTypes
- array of queue constrainer record
typesNullArgumentException
-
queueConstrainerRecordTypes
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- unable to get form for requested
record typesmandatory
- This method must be implemented. QueueConstrainer createQueueConstrainer(QueueConstrainerForm queueConstrainerForm) throws OperationFailedException, PermissionDeniedException
QueueConstrainer.
queueConstrainerForm
- the form for this QueueConstrainer
QueueConstrainer
IllegalStateException
- queueConstrainerForm
already used in a create transactionInvalidArgumentException
- one or more of the form
elements is invalidNullArgumentException
- queueConstrainerForm
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- queueConstrainerForm
did not originate from
getQueueConstrainerFormForCreate()
mandatory
- This method must be implemented. boolean canUpdateQueueConstrainers()
QueueConstrainer
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 QueueConstrainer
modification is not authorized, true
otherwisemandatory
- This method must be implemented. QueueConstrainerForm getQueueConstrainerFormForUpdate(Id queueConstrainerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
queueConstrainerId
- the Id
of the
QueueConstrainer
NotFoundException
- queueConstrainerId
is not foundNullArgumentException
- queueConstrainerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void updateQueueConstrainer(QueueConstrainerForm queueConstrainerForm) throws OperationFailedException, PermissionDeniedException
queueConstrainerForm
- the form containing the elements to be
updatedIllegalStateException
- queueConstrainerForm
already used in an update transactionInvalidArgumentException
- the form contains an invalid
valueNullArgumentException
- queueConstrainerForm
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- queueConstrainerForm
did not originate from
getQueueConstrainerFormForUpdate()
mandatory
- This method must be implemented. boolean canDeleteQueueConstrainers()
QueueConstrainer
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 QueueConstrainer
deletion is not authorized, true
otherwisemandatory
- This method must be implemented. void deleteQueueConstrainer(Id queueConstrainerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
QueueConstrainer.
queueConstrainerId
- the Id
of the
QueueConstrainer
to removeNotFoundException
- queueConstrainerId
not foundNullArgumentException
- queueConstrainerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canManageQueueConstrainerAliases()
Id
aliases for queue
constrainers. 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 QueueConstrainer
aliasing is not authorized, true
otherwisemandatory
- This method must be implemented. void aliasQueueConstrainer(Id queueConstrainerId, Id aliasId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
Id
to a QueueConstrainer
for the
purpose of creating compatibility. The primary Id
of
the QueueConstrainer
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. it
is reassigned to the given queue constrainer Id.
queueConstrainerId
- the Id
of a
QueueConstrainer
aliasId
- the alias Id
AlreadyExistsException
- aliasId
is
already assignedNotFoundException
- queueConstrainerId
not foundNullArgumentException
- queueConstrainerId
or aliasId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.