public interface PoolProcessorEnablerAdminSession extends OsidSession
This session creates and removes pool processor enablers. The data for
create and update is provided via the PoolProcessorEnablerForm.
Modifier and Type | Method and Description |
---|---|
void |
aliasPoolProcessorEnabler(Id poolProcessorEnablerId,
Id aliasId)
Adds an
Id to a PoolProcessorEnabler for
the purpose of creating compatibility. |
boolean |
canCreatePoolProcessorEnabler()
Tests if this user can create pool processor enablers.
|
boolean |
canCreatePoolProcessorEnablerWithRecordTypes(Type[] poolProcessorEnablerRecordTypes)
Tests if this user can create a single
PoolProcessorEnabler
using the desired record types. |
boolean |
canDeletePoolProcessorEnablers()
Tests if this user can delete pool processor enablers.
|
boolean |
canManagePoolProcessorEnablerAliases()
Tests if this user can manage
Id aliases for pool
processor enablers. |
boolean |
canUpdatePoolProcessorEnablers()
Tests if this user can update pool processor enablers.
|
PoolProcessorEnabler |
createPoolProcessorEnabler(PoolProcessorEnablerForm poolProcessorEnablerForm)
Creates a new
PoolProcessorEnabler. |
void |
deletePoolProcessorEnabler(Id poolProcessorEnablerId)
Deletes a
PoolProcessorEnabler. |
Distributor |
getDistributor()
Gets the
Distributor associated with this session. |
Id |
getDistributorId()
Gets the
Distributor Id associated with
this session. |
PoolProcessorEnablerForm |
getPoolProcessorEnablerFormForCreate(Type[] poolProcessorEnablerRecordTypes)
Gets the pool processor enabler form for creating new pool processor
enablers.
|
PoolProcessorEnablerForm |
getPoolProcessorEnablerFormForUpdate(Id poolProcessorEnablerId)
Gets the pool processor enabler form for updating an existing pool
processor enabler.
|
void |
updatePoolProcessorEnabler(PoolProcessorEnablerForm poolProcessorEnablerForm)
Updates an existing pool 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 canCreatePoolProcessorEnabler()
PoolProcessorEnabler
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 PoolProcessorEnabler
creation is not authorized, true
otherwisemandatory
- This method must be implemented. boolean canCreatePoolProcessorEnablerWithRecordTypes(Type[] poolProcessorEnablerRecordTypes)
PoolProcessorEnabler
using the desired record types. While
ProvisioningRulesManager.getPoolProcessorEnablerRecordTypes()
can be used to examine which records are supported, this method tests
which record(s) are required for creating a specific
PoolProcessorEnabler.
Providing an empty array tests if a
PoolProcessorEnabler
can be created with no records.poolProcessorEnablerRecordTypes
- array of pool processor
enabler record types true
if PoolProcessorEnabler
creation using the specified record Types
is
supported, false
otherwiseNullArgumentException
-
poolProcessorEnablerRecordTypes
is null
mandatory
- This method must be implemented. PoolProcessorEnablerForm getPoolProcessorEnablerFormForCreate(Type[] poolProcessorEnablerRecordTypes) throws OperationFailedException, PermissionDeniedException
poolProcessorEnablerRecordTypes
- array of pool processor
enabler record typesNullArgumentException
-
poolProcessorEnablerRecordTypes
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- unable to get form for requested
record typesmandatory
- This method must be implemented. PoolProcessorEnabler createPoolProcessorEnabler(PoolProcessorEnablerForm poolProcessorEnablerForm) throws OperationFailedException, PermissionDeniedException
PoolProcessorEnabler.
poolProcessorEnablerForm
- the form for this
PoolProcessorEnabler
PoolProcessorEnabler
IllegalStateException
- poolProcessorEnablerForm
already used in a create transactionInvalidArgumentException
- one or more of the form
elements is invalidNullArgumentException
- poolProcessorEnablerForm
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- poolProcessorEnablerForm
did not originate from
getPoolProcessorEnablerFormForCreate()
mandatory
- This method must be implemented. boolean canUpdatePoolProcessorEnablers()
PoolProcessorEnabler
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 PoolProcessorEnabler
modification is not authorized, true
otherwisemandatory
- This method must be implemented. PoolProcessorEnablerForm getPoolProcessorEnablerFormForUpdate(Id poolProcessorEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
poolProcessorEnablerId
- the Id
of the
PoolProcessorEnabler
NotFoundException
- poolProcessorEnablerId
is not foundNullArgumentException
- poolProcessorEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void updatePoolProcessorEnabler(PoolProcessorEnablerForm poolProcessorEnablerForm) throws OperationFailedException, PermissionDeniedException
poolProcessorEnablerForm
- the form containing the elements to
be updatedIllegalStateException
- poolProcessorEnablerForm
already used in an update transactionInvalidArgumentException
- the form contains an invalid
valueNullArgumentException
- poolProcessorEnablerForm
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- poolProcessorEnablerForm
did not originate from
getPoolProcessorEnablerFormForUpdate()
mandatory
- This method must be implemented. boolean canDeletePoolProcessorEnablers()
PoolProcessorEnabler
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 PoolProcessorEnabler
deletion is not authorized, true
otherwisemandatory
- This method must be implemented. void deletePoolProcessorEnabler(Id poolProcessorEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
PoolProcessorEnabler.
poolProcessorEnablerId
- the Id
of the
PoolProcessorEnabler
to removeNotFoundException
- poolProcessorEnablerId
not foundNullArgumentException
- poolProcessorEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canManagePoolProcessorEnablerAliases()
Id
aliases for pool
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 PoolProcessorEnabler
aliasing is not authorized, true
otherwisemandatory
- This method must be implemented. void aliasPoolProcessorEnabler(Id poolProcessorEnablerId, Id aliasId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
Id
to a PoolProcessorEnabler
for
the purpose of creating compatibility. The primary Id
of the PoolProcessorEnabler
is determined by the
provider. The new Id
performs as an alias to the
primary Id
. If the alias is a pointer to another pool
processor enabler. it is reassigned to the given pool processor
enabler Id.
poolProcessorEnablerId
- the Id
of a
PoolProcessorEnabler
aliasId
- the alias Id
AlreadyExistsException
- aliasId
is
already assignedNotFoundException
- poolProcessorEnablerId
not foundNullArgumentException
- poolProcessorEnablerId
or aliasId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.