public interface BrokerProcessorEnablerAdminSession extends OsidSession
This session creates and removes broker processor enablers. The data
for create and update is provided via the
BrokerProcessorEnablerForm.
Modifier and Type | Method and Description |
---|---|
void |
aliasBrokerProcessorEnabler(Id brokerProcessorEnablerId,
Id aliasId)
Adds an
Id to a BrokerProcessorEnabler
for the purpose of creating compatibility. |
boolean |
canCreateBrokerProcessorEnabler()
Tests if this user can create broker processor enablers.
|
boolean |
canCreateBrokerProcessorEnablerWithRecordTypes(Type[] brokerProcessorEnablerRecordTypes)
Tests if this user can create a single
BrokerProcessorEnabler
using the desired record types. |
boolean |
canDeleteBrokerProcessorEnablers()
Tests if this user can delete broker processor enablers.
|
boolean |
canManageBrokerProcessorEnablerAliases()
Tests if this user can manage
Id aliases for broker
processor enablers. |
boolean |
canUpdateBrokerProcessorEnablers()
Tests if this user can update broker processor enablers.
|
BrokerProcessorEnabler |
createBrokerProcessorEnabler(BrokerProcessorEnablerForm brokerProcessorEnablerForm)
Creates a new
BrokerProcessorEnabler. |
void |
deleteBrokerProcessorEnabler(Id brokerProcessorEnablerId)
Deletes a
BrokerProcessorEnabler. |
BrokerProcessorEnablerForm |
getBrokerProcessorEnablerFormForCreate(Type[] brokerProcessorEnablerRecordTypes)
Gets the broker processor enabler form for creating new broker
processor enablers.
|
BrokerProcessorEnablerForm |
getBrokerProcessorEnablerFormForUpdate(Id brokerProcessorEnablerId)
Gets the broker processor enabler form for updating an existing broker
processor enabler.
|
Distributor |
getDistributor()
Gets the
Distributor associated with this session. |
Id |
getDistributorId()
Gets the
Distributor Id associated with
this session. |
void |
updateBrokerProcessorEnabler(BrokerProcessorEnablerForm brokerProcessorEnablerForm)
Updates an existing broker processor 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 canCreateBrokerProcessorEnabler()
BrokerProcessorEnabler
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 BrokerProcessorEnabler
creation is not authorized, true
otherwisemandatory
- This method must be implemented. boolean canCreateBrokerProcessorEnablerWithRecordTypes(Type[] brokerProcessorEnablerRecordTypes)
BrokerProcessorEnabler
using the desired record types. While
ProvisioningRulesManager.getBrokerProcessorEnablerRecordTypes()
can be used to examine which records are supported, this
method tests which record(s) are required for creating a specific
BrokerProcessorEnabler.
Providing an empty array tests
if a BrokerProcessorEnabler
can be created with no
records.brokerProcessorEnablerRecordTypes
- array of broker processor
enabler record types true
if BrokerProcessorEnabler
creation using the specified record Types
is
supported, false
otherwiseNullArgumentException
-
brokerProcessorEnablerRecordTypes
is null
mandatory
- This method must be implemented. BrokerProcessorEnablerForm getBrokerProcessorEnablerFormForCreate(Type[] brokerProcessorEnablerRecordTypes) throws OperationFailedException, PermissionDeniedException
brokerProcessorEnablerRecordTypes
- array of broker processor
enabler record typesNullArgumentException
-
brokerProcessorEnablerRecordTypes
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- unable to get form for requested
record typesmandatory
- This method must be implemented. BrokerProcessorEnabler createBrokerProcessorEnabler(BrokerProcessorEnablerForm brokerProcessorEnablerForm) throws OperationFailedException, PermissionDeniedException
BrokerProcessorEnabler.
brokerProcessorEnablerForm
- the form for this
BrokerProcessorEnabler
BrokerProcessorEnabler
IllegalStateException
-
brokerProcessorEnablerForm
already used in a create
transactionInvalidArgumentException
- one or more of the form
elements is invalidNullArgumentException
-
brokerProcessorEnablerForm
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
-
brokerProcessorEnablerForm
did not originate from
getBrokerProcessorEnablerFormForCreate()
mandatory
- This method must be implemented. boolean canUpdateBrokerProcessorEnablers()
BrokerProcessorEnabler
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 BrokerProcessorEnabler
modification is not authorized, true
otherwisemandatory
- This method must be implemented. BrokerProcessorEnablerForm getBrokerProcessorEnablerFormForUpdate(Id brokerProcessorEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
brokerProcessorEnablerId
- the Id
of the
BrokerProcessorEnabler
NotFoundException
- brokerProcessorEnablerId
is not foundNullArgumentException
- brokerProcessorEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void updateBrokerProcessorEnabler(BrokerProcessorEnablerForm brokerProcessorEnablerForm) throws OperationFailedException, PermissionDeniedException
brokerProcessorEnablerForm
- the form containing the elements to
be updatedIllegalStateException
-
brokerProcessorEnablerForm
already used in an update
transactionInvalidArgumentException
- the form contains an invalid
valueNullArgumentException
-
brokerProcessorEnablerForm
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
-
brokerProcessorEnablerForm
did not originate from
getBrokerProcessorEnablerFormForUpdate()
mandatory
- This method must be implemented. boolean canDeleteBrokerProcessorEnablers()
BrokerProcessorEnabler
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 BrokerProcessorEnabler
deletion is not authorized, true
otherwisemandatory
- This method must be implemented. void deleteBrokerProcessorEnabler(Id brokerProcessorEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
BrokerProcessorEnabler.
brokerProcessorEnablerId
- the Id
of the
BrokerProcessorEnabler
to removeNotFoundException
- brokerProcessorEnablerId
not foundNullArgumentException
- brokerProcessorEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canManageBrokerProcessorEnablerAliases()
Id
aliases for broker
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 BrokerProcessorEnabler
aliasing is not authorized, true
otherwisemandatory
- This method must be implemented. void aliasBrokerProcessorEnabler(Id brokerProcessorEnablerId, Id aliasId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
Id
to a BrokerProcessorEnabler
for the purpose of creating compatibility. The primary Id
of the BrokerProcessorEnabler
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 processor enabler. it is reassigned to the given broker
processor enabler Id.
brokerProcessorEnablerId
- the Id
of a
BrokerProcessorEnabler
aliasId
- the alias Id
AlreadyExistsException
- aliasId
is
already assignedNotFoundException
- brokerProcessorEnablerId
not foundNullArgumentException
- brokerProcessorEnablerId
or aliasId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.