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