public interface PoolProcessorAdminSession extends OsidSession
This session creates and removes pool processors. The data for create
and update is provided via the PoolProcessorForm.
Modifier and Type | Method and Description |
---|---|
void |
aliasPoolProcessor(Id poolProcessorId,
Id aliasId)
Adds an
Id to a PoolProcessor for the
purpose of creating compatibility. |
boolean |
canCreatePoolProcessor()
Tests if this user can create pool processors.
|
boolean |
canCreatePoolProcessorWithRecordTypes(Type[] poolProcessorRecordTypes)
Tests if this user can create a single
PoolProcessor
using the desired record types. |
boolean |
canDeletePoolProcessors()
Tests if this user can delete pool processors.
|
boolean |
canManagePoolProcessorAliases()
Tests if this user can manage
Id aliases for pool
processors. |
boolean |
canUpdatePoolProcessors()
Tests if this user can update pool processors.
|
PoolProcessor |
createPoolProcessor(PoolProcessorForm poolProcessorForm)
Creates a new
PoolProcessor. |
void |
deletePoolProcessor(Id poolProcessorId)
Deletes a
PoolProcessor. |
Distributor |
getDistributor()
Gets the
Distributor associated with this session. |
Id |
getDistributorId()
Gets the
Distributor Id associated with
this session. |
PoolProcessorForm |
getPoolProcessorFormForCreate(Type[] poolProcessorRecordTypes)
Gets the pool processor form for creating new pool processors.
|
PoolProcessorForm |
getPoolProcessorFormForUpdate(Id poolProcessorId)
Gets the pool processor form for updating an existing pool processor.
|
void |
updatePoolProcessor(PoolProcessorForm poolProcessorForm)
Updates a existing pool processor.
|
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 canCreatePoolProcessor()
PoolProcessor
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 PoolProcessor
creation
is not authorized, true
otherwisemandatory
- This method must be implemented. boolean canCreatePoolProcessorWithRecordTypes(Type[] poolProcessorRecordTypes)
PoolProcessor
using the desired record types. While
ProvisioningRulesManager.getPoolProcessorRecordTypes()
can be
used to examine which records are supported, this method tests which
record(s) are required for creating a specific PoolProcessor.
Providing an empty array tests if a PoolProcessor
can be created with no records.poolProcessorRecordTypes
- array of pool processor record types true
if PoolProcessor
creation
using the specified record Types
is supported,
false
otherwiseNullArgumentException
- poolProcessorRecordTypes
is null
mandatory
- This method must be implemented. PoolProcessorForm getPoolProcessorFormForCreate(Type[] poolProcessorRecordTypes) throws OperationFailedException, PermissionDeniedException
poolProcessorRecordTypes
- array of pool processor record typesNullArgumentException
- poolProcessorRecordTypes
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- unable to get form for requested
record typesmandatory
- This method must be implemented. PoolProcessor createPoolProcessor(PoolProcessorForm poolProcessorForm) throws OperationFailedException, PermissionDeniedException
PoolProcessor.
poolProcessorForm
- the form for this PoolProcessor
PoolProcessor
IllegalStateException
- poolProcessorForm
already used in a create transactionInvalidArgumentException
- one or more of the form
elements is invalidNullArgumentException
- poolProcessorForm
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- poolProcessorForm
did not originate from getPoolProcessorFormForCreate()
mandatory
- This method must be implemented. boolean canUpdatePoolProcessors()
PoolProcessor
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 PoolProcessor
modification is not authorized, true
otherwisemandatory
- This method must be implemented. PoolProcessorForm getPoolProcessorFormForUpdate(Id poolProcessorId) throws NotFoundException, OperationFailedException, PermissionDeniedException
poolProcessorId
- the Id
of the
PoolProcessor
NotFoundException
- poolProcessorId
is
not foundNullArgumentException
- poolProcessorId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void updatePoolProcessor(PoolProcessorForm poolProcessorForm) throws OperationFailedException, PermissionDeniedException
poolProcessorForm
- the form containing the elements to be
updatedIllegalStateException
- poolProcessorForm
already used in an update transactionInvalidArgumentException
- the form contains an invalid
valueNullArgumentException
- poolProcessorForm
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- poolProcessorForm
did not originate from getPoolProcessorFormForUpdate()
mandatory
- This method must be implemented. boolean canDeletePoolProcessors()
PoolProcessor
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 PoolProcessor
deletion
is not authorized, true
otherwisemandatory
- This method must be implemented. void deletePoolProcessor(Id poolProcessorId) throws NotFoundException, OperationFailedException, PermissionDeniedException
PoolProcessor.
poolProcessorId
- the Id
of the
PoolProcessor
to removeNotFoundException
- poolProcessorId
not
foundNullArgumentException
- poolProcessorId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canManagePoolProcessorAliases()
Id
aliases for pool
processors. 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 PoolProcessor
aliasing
is not authorized, true
otherwisemandatory
- This method must be implemented. void aliasPoolProcessor(Id poolProcessorId, Id aliasId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
Id
to a PoolProcessor
for the
purpose of creating compatibility. The primary Id
of
the PoolProcessor
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. it is
reassigned to the given pool processor Id.
poolProcessorId
- the Id
of a
PoolProcessor
aliasId
- the alias Id
AlreadyExistsException
- aliasId
is
already assignedNotFoundException
- poolProcessorId
not
foundNullArgumentException
- poolProcessorId
or aliasId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.