org.osid.provisioning.rules

Interface PoolConstrainerAdminSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidSession

public interface PoolConstrainerAdminSession
extends OsidSession

This session creates and removes pool constrainers. The data for create and update is provided via the PoolConstrainerForm.

Method Summary

Methods

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.

Methods inherited from interface org.osid.OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

getDistributorId

Id getDistributorId()

Gets the Distributor Id associated with this session.

Returns:

the Distributor Id associated with this session

Compliance:

mandatory - This method must be implemented.

getDistributor

Distributor getDistributor()
                           throws OperationFailedException,
                                  PermissionDeniedException

Gets the Distributor associated with this session.

Returns:

the distributor

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canCreatePoolConstrainer

boolean canCreatePoolConstrainer()

Tests if this user can create pool constrainers. A return of true does not guarantee successful authorization. A return of false indicates that it is known creating a 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.

Returns:

false if PoolConstrainer creation is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

canCreatePoolConstrainerWithRecordTypes

boolean canCreatePoolConstrainerWithRecordTypes(Type[] poolConstrainerRecordTypes)

Tests if this user can create a single 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.

Parameters:

poolConstrainerRecordTypes - array of pool constrainer record types

Returns:

true if PoolConstrainer creation using the specified record Types is supported, false otherwise

Throws:

NullArgumentException - poolConstrainerRecordTypes is null

Compliance:

mandatory - This method must be implemented.

getPoolConstrainerFormForCreate

PoolConstrainerForm getPoolConstrainerFormForCreate(Type[] poolConstrainerRecordTypes)
                                                    throws OperationFailedException,
                                                           PermissionDeniedException

Gets the pool constrainer form for creating new pool constrainers. A new form should be requested for each create transaction.

Parameters:

poolConstrainerRecordTypes - array of pool constrainer record types

Returns:

the pool constrainer form

Throws:

NullArgumentException - poolConstrainerRecordTypes is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - unable to get form for requested record types

Compliance:

mandatory - This method must be implemented.

createPoolConstrainer

PoolConstrainer createPoolConstrainer(PoolConstrainerForm poolConstrainerForm)
                                      throws OperationFailedException,
                                             PermissionDeniedException

Creates a new PoolConstrainer.

Parameters:

poolConstrainerForm - the form for this PoolConstrainer

Returns:

the new PoolConstrainer

Throws:

IllegalStateException - poolConstrainerForm already used in a create transaction

InvalidArgumentException - one or more of the form elements is invalid

NullArgumentException - poolConstrainerForm is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - poolConstrainerForm did not originate from getPoolConstrainerFormForCreate()

Compliance:

mandatory - This method must be implemented.

canUpdatePoolConstrainers

boolean canUpdatePoolConstrainers()

Tests if this user can update pool constrainers. A return of true does not guarantee successful authorization. A return of false indicates that it is known updating a 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.

Returns:

false if PoolConstrainer modification is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

getPoolConstrainerFormForUpdate

PoolConstrainerForm getPoolConstrainerFormForUpdate(Id poolConstrainerId)
                                                    throws NotFoundException,
                                                           OperationFailedException,
                                                           PermissionDeniedException

Gets the pool constrainer form for updating an existing pool constrainer. A new pool constrainer form should be requested for each update transaction.

Parameters:

poolConstrainerId - the Id of the PoolConstrainer

Returns:

the pool constrainer form

Throws:

NotFoundException - poolConstrainerId is not found

NullArgumentException - poolConstrainerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

updatePoolConstrainer

void updatePoolConstrainer(PoolConstrainerForm poolConstrainerForm)
                           throws OperationFailedException,
                                  PermissionDeniedException

Updates an existing pool constrainer.

Parameters:

poolConstrainerForm - the form containing the elements to be updated

Throws:

IllegalStateException - poolConstrainerForm already used in an update transaction

InvalidArgumentException - the form contains an invalid value

NullArgumentException - poolConstrainerForm is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - poolConstrainerForm did not originate from getPoolConstrainerFormForUpdate()

Compliance:

mandatory - This method must be implemented.

canDeletePoolConstrainers

boolean canDeletePoolConstrainers()

Tests if this user can delete pool constrainers. A return of true does not guarantee successful authorization. A return of false indicates that it is known deleting a 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.

Returns:

false if PoolConstrainer deletion is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

deletePoolConstrainer

void deletePoolConstrainer(Id poolConstrainerId)
                           throws NotFoundException,
                                  OperationFailedException,
                                  PermissionDeniedException

Deletes a PoolConstrainer.

Parameters:

poolConstrainerId - the Id of the PoolConstrainer to remove

Throws:

NotFoundException - poolConstrainerId not found

NullArgumentException - poolConstrainerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canManagePoolConstrainerAliases

boolean canManagePoolConstrainerAliases()

Tests if this user can manage 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.

Returns:

false if PoolConstrainer aliasing is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

aliasPoolConstrainer

void aliasPoolConstrainer(Id poolConstrainerId,
                        Id aliasId)
                          throws AlreadyExistsException,
                                 NotFoundException,
                                 OperationFailedException,
                                 PermissionDeniedException

Adds an 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.

Parameters:

poolConstrainerId - the Id of a PoolConstrainer

aliasId - the alias Id

Throws:

AlreadyExistsException - aliasId is already assigned

NotFoundException - poolConstrainerId not found

NullArgumentException - poolConstrainerId or aliasId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.