org.osid.provisioning.rules

Interface PoolProcessorEnablerAdminSession

All Superinterfaces:

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

public interface PoolProcessorEnablerAdminSession
extends OsidSession

This session creates and removes pool processor enablers. The data for create and update is provided via the PoolProcessorEnablerForm.

Method Summary

Methods

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.

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.

canCreatePoolProcessorEnabler

boolean canCreatePoolProcessorEnabler()

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

Returns:

false if PoolProcessorEnabler creation is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

canCreatePoolProcessorEnablerWithRecordTypes

boolean canCreatePoolProcessorEnablerWithRecordTypes(Type[] poolProcessorEnablerRecordTypes)

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

Parameters:

poolProcessorEnablerRecordTypes - array of pool processor enabler record types

Returns:

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

Throws:

NullArgumentException - poolProcessorEnablerRecordTypes is null

Compliance:

mandatory - This method must be implemented.

getPoolProcessorEnablerFormForCreate

PoolProcessorEnablerForm getPoolProcessorEnablerFormForCreate(Type[] poolProcessorEnablerRecordTypes)
                                                              throws OperationFailedException,
                                                                     PermissionDeniedException

Gets the pool processor enabler form for creating new pool processor enablers. A new form should be requested for each create transaction.

Parameters:

poolProcessorEnablerRecordTypes - array of pool processor enabler record types

Returns:

the pool processor enabler form

Throws:

NullArgumentException - poolProcessorEnablerRecordTypes 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.

createPoolProcessorEnabler

PoolProcessorEnabler createPoolProcessorEnabler(PoolProcessorEnablerForm poolProcessorEnablerForm)
                                                throws OperationFailedException,
                                                       PermissionDeniedException

Creates a new PoolProcessorEnabler.

Parameters:

poolProcessorEnablerForm - the form for this PoolProcessorEnabler

Returns:

the new PoolProcessorEnabler

Throws:

IllegalStateException - poolProcessorEnablerForm already used in a create transaction

InvalidArgumentException - one or more of the form elements is invalid

NullArgumentException - poolProcessorEnablerForm is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - poolProcessorEnablerForm did not originate from getPoolProcessorEnablerFormForCreate()

Compliance:

mandatory - This method must be implemented.

canUpdatePoolProcessorEnablers

boolean canUpdatePoolProcessorEnablers()

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

Returns:

false if PoolProcessorEnabler modification is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

getPoolProcessorEnablerFormForUpdate

PoolProcessorEnablerForm getPoolProcessorEnablerFormForUpdate(Id poolProcessorEnablerId)
                                                              throws NotFoundException,
                                                                     OperationFailedException,
                                                                     PermissionDeniedException

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

Parameters:

poolProcessorEnablerId - the Id of the PoolProcessorEnabler

Returns:

the pool processor enabler form

Throws:

NotFoundException - poolProcessorEnablerId is not found

NullArgumentException - poolProcessorEnablerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

updatePoolProcessorEnabler

void updatePoolProcessorEnabler(PoolProcessorEnablerForm poolProcessorEnablerForm)
                                throws OperationFailedException,
                                       PermissionDeniedException

Updates an existing pool processor enabler.

Parameters:

poolProcessorEnablerForm - the form containing the elements to be updated

Throws:

IllegalStateException - poolProcessorEnablerForm already used in an update transaction

InvalidArgumentException - the form contains an invalid value

NullArgumentException - poolProcessorEnablerForm is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - poolProcessorEnablerForm did not originate from getPoolProcessorEnablerFormForUpdate()

Compliance:

mandatory - This method must be implemented.

canDeletePoolProcessorEnablers

boolean canDeletePoolProcessorEnablers()

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

Returns:

false if PoolProcessorEnabler deletion is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

deletePoolProcessorEnabler

void deletePoolProcessorEnabler(Id poolProcessorEnablerId)
                                throws NotFoundException,
                                       OperationFailedException,
                                       PermissionDeniedException

Deletes a PoolProcessorEnabler.

Parameters:

poolProcessorEnablerId - the Id of the PoolProcessorEnabler to remove

Throws:

NotFoundException - poolProcessorEnablerId not found

NullArgumentException - poolProcessorEnablerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canManagePoolProcessorEnablerAliases

boolean canManagePoolProcessorEnablerAliases()

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

Returns:

false if PoolProcessorEnabler aliasing is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

aliasPoolProcessorEnabler

void aliasPoolProcessorEnabler(Id poolProcessorEnablerId,
                             Id aliasId)
                               throws AlreadyExistsException,
                                      NotFoundException,
                                      OperationFailedException,
                                      PermissionDeniedException

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

Parameters:

poolProcessorEnablerId - the Id of a PoolProcessorEnabler

aliasId - the alias Id

Throws:

AlreadyExistsException - aliasId is already assigned

NotFoundException - poolProcessorEnablerId not found

NullArgumentException - poolProcessorEnablerId or aliasId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.