public interface PoolConstrainerEnablerAdminSession extends OsidSession
This session creates and removes pool constrainer enablers. The data
for create and update is provided via the
PoolConstrainerEnablerForm.
Modifier and Type | Method and Description |
---|---|
void |
aliasPoolConstrainerEnabler(Id poolConstrainerEnablerId,
Id aliasId)
Adds an
Id to a PoolConstrainerEnabler
for the purpose of creating compatibility. |
boolean |
canCreatePoolConstrainerEnabler()
Tests if this user can create pool constrainer enablers.
|
boolean |
canCreatePoolConstrainerEnablerWithRecordTypes(Type[] poolConstrainerEnablerRecordTypes)
Tests if this user can create a single
PoolConstrainerEnabler
using the desired record types. |
boolean |
canDeletePoolConstrainerEnablers()
Tests if this user can delete pool constrainer enablers.
|
boolean |
canManagePoolConstrainerEnablerAliases()
Tests if this user can manage
Id aliases for pool
constrainer enablers. |
boolean |
canUpdatePoolConstrainerEnablers()
Tests if this user can update pool constrainer enablers.
|
PoolConstrainerEnabler |
createPoolConstrainerEnabler(PoolConstrainerEnablerForm poolConstrainerEnablerForm)
Creates a new
PoolConstrainerEnabler. |
void |
deletePoolConstrainerEnabler(Id poolConstrainerEnablerId)
Deletes a
PoolConstrainerEnabler. |
Distributor |
getDistributor()
Gets the
Distributor associated with this session. |
Id |
getDistributorId()
Gets the
Distributor Id associated with
this session. |
PoolConstrainerEnablerForm |
getPoolConstrainerEnablerFormForCreate(Type[] poolConstrainerEnablerRecordTypes)
Gets the pool constrainer enabler form for creating new pool
constrainer enablers.
|
PoolConstrainerEnablerForm |
getPoolConstrainerEnablerFormForUpdate(Id poolConstrainerEnablerId)
Gets the pool constrainer enabler form for updating a existing pool
constrainer enabler.
|
void |
updatePoolConstrainerEnabler(PoolConstrainerEnablerForm poolConstrainerEnablerForm)
Updates an existing pool 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 canCreatePoolConstrainerEnabler()
PoolConstrainerEnabler
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 PoolConstrainerEnabler
creation is not authorized, true
otherwisemandatory
- This method must be implemented. boolean canCreatePoolConstrainerEnablerWithRecordTypes(Type[] poolConstrainerEnablerRecordTypes)
PoolConstrainerEnabler
using the desired record types. While
ProvisioningRulesManager.getPoolConstrainerEnablerRecordTypes()
can be used to examine which records are supported, this
method tests which record(s) are required for creating a specific
PoolConstrainerEnabler.
Providing an empty array tests
if a PoolConstrainerEnabler
can be created with no
records.poolConstrainerEnablerRecordTypes
- array of pool constrainer
enabler record types true
if PoolConstrainerEnabler
creation using the specified record Types
is
supported, false
otherwiseNullArgumentException
-
poolConstrainerEnablerRecordTypes
is null
mandatory
- This method must be implemented. PoolConstrainerEnablerForm getPoolConstrainerEnablerFormForCreate(Type[] poolConstrainerEnablerRecordTypes) throws OperationFailedException, PermissionDeniedException
poolConstrainerEnablerRecordTypes
- array of pool constrainer
enabler record typesNullArgumentException
-
poolConstrainerEnablerRecordTypes
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
- unable to get form for requested
record typesmandatory
- This method must be implemented. PoolConstrainerEnabler createPoolConstrainerEnabler(PoolConstrainerEnablerForm poolConstrainerEnablerForm) throws OperationFailedException, PermissionDeniedException
PoolConstrainerEnabler.
poolConstrainerEnablerForm
- the form for this
PoolConstrainerEnabler
PoolConstrainerEnabler
IllegalStateException
-
poolConstrainerEnablerForm
already used in a create
transactionInvalidArgumentException
- one or more of the form
elements is invalidNullArgumentException
-
poolConstrainerEnablerForm
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
-
poolConstrainerEnablerForm
did not originate from
getPoolconstrainerEnablerForCreate()
mandatory
- This method must be implemented. boolean canUpdatePoolConstrainerEnablers()
PoolConstrainerEnabler
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 PoolConstrainerEnabler
modification is not authorized, true
otherwisemandatory
- This method must be implemented. PoolConstrainerEnablerForm getPoolConstrainerEnablerFormForUpdate(Id poolConstrainerEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
poolConstrainerEnablerId
- the Id
of the
PoolConstrainerEnabler
NotFoundException
- poolConstrainerEnablerId
is not foundNullArgumentException
- poolConstrainerEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. void updatePoolConstrainerEnabler(PoolConstrainerEnablerForm poolConstrainerEnablerForm) throws OperationFailedException, PermissionDeniedException
poolConstrainerEnablerForm
- the form containing the elements to
be updatedIllegalStateException
-
poolConstrainerEnablerForm
already used in an update
transactionInvalidArgumentException
- the form contains an invalid
valueOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failureUnsupportedException
-
poolConstrainerEnablerForm
did not originate from
getPoolconstrainerEnablerForUpdate()
mandatory
- This method must be implemented. boolean canDeletePoolConstrainerEnablers()
PoolConstrainerEnabler
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 PoolConstrainerEnabler
deletion is not authorized, true
otherwisemandatory
- This method must be implemented. void deletePoolConstrainerEnabler(Id poolConstrainerEnablerId) throws NotFoundException, OperationFailedException, PermissionDeniedException
PoolConstrainerEnabler.
poolConstrainerEnablerId
- the Id
of the
PoolConstrainerEnabler
to removeNotFoundException
- poolConstrainerEnablerId
not foundNullArgumentException
- poolConstrainerEnablerId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canManagePoolConstrainerEnablerAliases()
Id
aliases for pool
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 PoolConstrainerEnabler
aliasing is not authorized, true
otherwisemandatory
- This method must be implemented. void aliasPoolConstrainerEnabler(Id poolConstrainerEnablerId, Id aliasId) throws AlreadyExistsException, NotFoundException, OperationFailedException, PermissionDeniedException
Id
to a PoolConstrainerEnabler
for the purpose of creating compatibility. The primary Id
of the PoolConstrainerEnabler
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 enabler. it is reassigned to the given pool constrainer
enabler Id.
poolConstrainerEnablerId
- the Id
of a
PoolConstrainerEnabler
aliasId
- the alias Id
AlreadyExistsException
- aliasId
is
already assignedNotFoundException
- poolConstrainerEnablerId
not foundNullArgumentException
- poolConstrainerEnablerId
or aliasId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.