public interface BrokerConstrainerAdminSession extends OsidSession
This session creates and removes broker constrainers. The data for
create and update is provided via the BrokerConstrainerForm.
Modifier and Type | Method and Description |
---|---|
void |
aliasBrokerConstrainer(Id brokerConstrainerId,
Id aliasId)
Adds an
Id to a BrokerConstrainer for
the purpose of creating compatibility. |
boolean |
canCreateBrokerConstrainer()
Tests if this user can create broker constrainers.
|
boolean |
canCreateBrokerConstrainerWithRecordTypes(Type[] brokerConstrainerRecordTypes)
Tests if this user can create a single
BrokerConstrainer
using the desired record types. |
boolean |
canDeleteBrokerConstrainers()
Tests if this user can delete broker constrainers.
|
boolean |
canManageBrokerConstrainerAliases()
Tests if this user can manage
Id aliases for broker
constrainers. |
boolean |
canUpdateBrokerConstrainers()
Tests if this user can update broker constrainers.
|
BrokerConstrainer |
createBrokerConstrainer(BrokerConstrainerForm brokerConstrainerForm)
Creates a new
BrokerConstrainer. |
void |
deleteBrokerConstrainer(Id brokerConstrainerId)
Deletes a
BrokerConstrainer. |
BrokerConstrainerForm |
getBrokerConstrainerFormForCreate(Type[] brokerConstrainerRecordTypes)
Gets the broker constrainer form for creating new broker constrainers.
|
BrokerConstrainerForm |
getBrokerConstrainerFormForUpdate(Id brokerConstrainerId)
Gets the broker constrainer form for updating an existing broker
constrainer.
|
Distributor |
getDistributor()
Gets the
Distributor associated with this session. |
Id |
getDistributorId()
Gets the
Distributor Id associated with
this session. |
void |
updateBrokerConstrainer(BrokerConstrainerForm brokerConstrainerForm)
Updates an existing broker 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 canCreateBrokerConstrainer()
BrokerConstrainer
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 BrokerConstrainer
creation is not authorized, true
otherwisemandatory
- This method must be implemented. boolean canCreateBrokerConstrainerWithRecordTypes(Type[] brokerConstrainerRecordTypes)
BrokerConstrainer
using the desired record types. While
ProvisioningRulesManager.getBrokerConstrainerRecordTypes()
can
be used to examine which records are supported, this method tests
which record(s) are required for creating a specific
BrokerConstrainer.
Providing an empty array tests if a
BrokerConstrainer
can be created with no records.brokerConstrainerRecordTypes
- array of broker constrainer
record types true
if BrokerConstrainer
creation using the specified record Types
is
supported, false
otherwiseNullArgumentException
-
brokerConstrainerRecordTypes
is null
mandatory
- This method must be implemented. BrokerConstrainerForm getBrokerConstrainerFormForCreate(Type[] brokerConstrainerRecordTypes) throws OperationFailedException, PermissionDeniedException
brokerConstrainerRecordTypes
- array of broker constrainer
record typesNullArgumentException
-
brokerConstrainerRecordTypes
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- unable to get form for requested
record typesmandatory
- This method must be implemented. BrokerConstrainer createBrokerConstrainer(BrokerConstrainerForm brokerConstrainerForm) throws OperationFailedException, PermissionDeniedException
BrokerConstrainer.
brokerConstrainerForm
- the form for this
BrokerConstrainer
BrokerConstrainer
IllegalStateException
- brokerConstrainerForm
already used in a create transactionInvalidArgumentException
- one or more of the form
elements is invalidNullArgumentException
- brokerConstrainerForm
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- brokerConstrainerForm
did not originate from
getBrokerConstrainerFormForCreate()
mandatory
- This method must be implemented. boolean canUpdateBrokerConstrainers()
BrokerConstrainer
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 BrokerConstrainer
modification is not authorized, true
otherwisemandatory
- This method must be implemented. BrokerConstrainerForm getBrokerConstrainerFormForUpdate(Id brokerConstrainerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
brokerConstrainerId
- the Id
of the
BrokerConstrainer
NotFoundException
- brokerConstrainerId
is not foundNullArgumentException
- brokerConstrainerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void updateBrokerConstrainer(BrokerConstrainerForm brokerConstrainerForm) throws OperationFailedException, PermissionDeniedException
brokerConstrainerForm
- the form containing the elements to be
updatedIllegalStateException
- brokerConstrainerForm
already used in an update transactionInvalidArgumentException
- the form contains an invalid
valueNullArgumentException
- brokerConstrainerForm
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- brokerConstrainerForm
did not originate from
getBrokerConstrainerFormForUpdate()
mandatory
- This method must be implemented. boolean canDeleteBrokerConstrainers()
BrokerConstrainer
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 BrokerConstrainer
deletion is not authorized, true
otherwisemandatory
- This method must be implemented. void deleteBrokerConstrainer(Id brokerConstrainerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
BrokerConstrainer.
brokerConstrainerId
- the Id
of the
BrokerConstrainer
to removeNotFoundException
- brokerConstrainerId
not foundNullArgumentException
- brokerConstrainerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canManageBrokerConstrainerAliases()
Id
aliases for broker
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 BrokerConstrainer
aliasing is not authorized, true
otherwisemandatory
- This method must be implemented. void aliasBrokerConstrainer(Id brokerConstrainerId, Id aliasId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
Id
to a BrokerConstrainer
for
the purpose of creating compatibility. The primary Id
of the BrokerConstrainer
is determined by the provider.
The new Id
performs as an alias to the primary
Id
. If the alias is a pointer to another broker constrainer.
it is reassigned to the given broker constrainer Id.
brokerConstrainerId
- the Id
of a
BrokerConstrainer
aliasId
- the alias Id
AlreadyExistsException
- aliasId
is
already assignedNotFoundException
- brokerConstrainerId
not foundNullArgumentException
- brokerConstrainerId
or aliasId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.