public interface PoolConstrainerAdminSession extends OsidSession
This session creates and removes pool constrainers. The data for create
and update is provided via the PoolConstrainerForm.
Modifier and Type | Method and Description |
---|---|
void |
aliasPoolConstrainer(Id poolConstrainerId,
Id aliasId)
Adds an
Id to a PoolConstrainer for the
purpose of creating compatibility. |
boolean |
canCreatePoolConstrainer()
Tests if this user can create pool constrainers.
|
boolean |
canCreatePoolConstrainerWithRecordTypes(Type[] poolConstrainerRecordTypes)
Tests if this user can create a single
PoolConstrainer
using the desired record types. |
boolean |
canDeletePoolConstrainers()
Tests if this user can delete pool constrainers.
|
boolean |
canManagePoolConstrainerAliases()
Tests if this user can manage
Id aliases for pool
constrainers. |
boolean |
canUpdatePoolConstrainers()
Tests if this user can update pool constrainers.
|
PoolConstrainer |
createPoolConstrainer(PoolConstrainerForm poolConstrainerForm)
Creates a new
PoolConstrainer. |
void |
deletePoolConstrainer(Id poolConstrainerId)
Deletes a
PoolConstrainer. |
Distributor |
getDistributor()
Gets the
Distributor associated with this session. |
Id |
getDistributorId()
Gets the
Distributor Id associated with
this session. |
PoolConstrainerForm |
getPoolConstrainerFormForCreate(Type[] poolConstrainerRecordTypes)
Gets the pool constrainer form for creating new pool constrainers.
|
PoolConstrainerForm |
getPoolConstrainerFormForUpdate(Id poolConstrainerId)
Gets the pool constrainer form for updating an existing pool
constrainer.
|
void |
updatePoolConstrainer(PoolConstrainerForm poolConstrainerForm)
Updates an existing pool 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 canCreatePoolConstrainer()
PoolConstrainer
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 PoolConstrainer
creation is not authorized, true
otherwisemandatory
- This method must be implemented. boolean canCreatePoolConstrainerWithRecordTypes(Type[] poolConstrainerRecordTypes)
PoolConstrainer
using the desired record types. While
ProvisioningRulesManager.getPoolConstrainerRecordTypes()
can
be used to examine which records are supported, this method tests
which record(s) are required for creating a specific
PoolConstrainer.
Providing an empty array tests if a
PoolConstrainer
can be created with no records.poolConstrainerRecordTypes
- array of pool constrainer record
types true
if PoolConstrainer
creation
using the specified record Types
is supported,
false
otherwiseNullArgumentException
-
poolConstrainerRecordTypes
is null
mandatory
- This method must be implemented. PoolConstrainerForm getPoolConstrainerFormForCreate(Type[] poolConstrainerRecordTypes) throws OperationFailedException, PermissionDeniedException
poolConstrainerRecordTypes
- array of pool constrainer record
typesNullArgumentException
-
poolConstrainerRecordTypes
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- unable to get form for requested
record typesmandatory
- This method must be implemented. PoolConstrainer createPoolConstrainer(PoolConstrainerForm poolConstrainerForm) throws OperationFailedException, PermissionDeniedException
PoolConstrainer.
poolConstrainerForm
- the form for this PoolConstrainer
PoolConstrainer
IllegalStateException
- poolConstrainerForm
already used in a create transactionInvalidArgumentException
- one or more of the form
elements is invalidNullArgumentException
- poolConstrainerForm
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- poolConstrainerForm
did not originate from
getPoolConstrainerFormForCreate()
mandatory
- This method must be implemented. boolean canUpdatePoolConstrainers()
PoolConstrainer
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 PoolConstrainer
modification is not authorized, true
otherwisemandatory
- This method must be implemented. PoolConstrainerForm getPoolConstrainerFormForUpdate(Id poolConstrainerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
poolConstrainerId
- the Id
of the
PoolConstrainer
NotFoundException
- poolConstrainerId
is
not foundNullArgumentException
- poolConstrainerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void updatePoolConstrainer(PoolConstrainerForm poolConstrainerForm) throws OperationFailedException, PermissionDeniedException
poolConstrainerForm
- the form containing the elements to be
updatedIllegalStateException
- poolConstrainerForm
already used in an update transactionInvalidArgumentException
- the form contains an invalid
valueNullArgumentException
- poolConstrainerForm
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- poolConstrainerForm
did not originate from
getPoolConstrainerFormForUpdate()
mandatory
- This method must be implemented. boolean canDeletePoolConstrainers()
PoolConstrainer
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 PoolConstrainer
deletion is not authorized, true
otherwisemandatory
- This method must be implemented. void deletePoolConstrainer(Id poolConstrainerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
PoolConstrainer.
poolConstrainerId
- the Id
of the
PoolConstrainer
to removeNotFoundException
- poolConstrainerId
not foundNullArgumentException
- poolConstrainerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canManagePoolConstrainerAliases()
Id
aliases for pool
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 PoolConstrainer
aliasing is not authorized, true
otherwisemandatory
- This method must be implemented. void aliasPoolConstrainer(Id poolConstrainerId, Id aliasId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
Id
to a PoolConstrainer
for the
purpose of creating compatibility. The primary Id
of
the PoolConstrainer
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 constrainer. it is
reassigned to the given pool constrainer Id.
poolConstrainerId
- the Id
of a
PoolConstrainer
aliasId
- the alias Id
AlreadyExistsException
- aliasId
is
already assignedNotFoundException
- poolConstrainerId
not foundNullArgumentException
- poolConstrainerId
or aliasId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.