org.osid.provisioning.rules

Interface QueueProcessorEnablerAdminSession

All Superinterfaces:

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

public interface QueueProcessorEnablerAdminSession
extends OsidSession

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

Method Summary

Methods

Modifier and Type	Method and Description
void	aliasQueueProcessorEnabler(Id queueProcessorEnablerId, Id aliasId) Adds a Id to a QueueProcessorEnabler for the purpose of creating compatibility.
boolean	canCreateQueueProcessorEnabler() Tests if this user can create queue processor enablers.
boolean	canCreateQueueProcessorEnablerWithRecordTypes(Type[] queueProcessorEnablerRecordTypes) Tests if this user can create a single QueueProcessorEnabler using the desired record types.
boolean	canDeleteQueueProcessorEnablers() Tests if this user can delete queue processor enablers.
boolean	canManageQueueProcessorEnablerAliases() Tests if this user can manage Id aliases for queue processor enablers.
boolean	canUpdateQueueProcessorEnablers() Tests if this user can update queue processor enablers.
QueueProcessorEnabler	createQueueProcessorEnabler(QueueProcessorEnablerForm queueProcessorEnablerForm) Creates a new QueueProcessorEnabler.
void	deleteQueueProcessorEnabler(Id queueProcessorEnablerId) Deletes a QueueProcessorEnabler.
Distributor	getDistributor() Gets the Distributor associated with this session.
Id	getDistributorId() Gets the Distributor Id associated with this session.
QueueProcessorEnablerForm	getQueueProcessorEnablerFormForCreate() Gets the queue processor enabler form for creating new queue processor enablers.
QueueProcessorEnablerForm	getQueueProcessorEnablerFormForUpdate(Id queueProcessorEnablerId) Gets the queue processor enabler form for updating an existing queue processor enabler.
void	updateQueueProcessorEnabler(QueueProcessorEnablerForm queueProcessorEnablerForm) Updates an existing queue 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.

canCreateQueueProcessorEnabler

boolean canCreateQueueProcessorEnabler()

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

Compliance:

mandatory - This method must be implemented.

canCreateQueueProcessorEnablerWithRecordTypes

boolean canCreateQueueProcessorEnablerWithRecordTypes(Type[] queueProcessorEnablerRecordTypes)

Tests if this user can create a single QueueProcessorEnabler using the desired record types. While ProvisioningRulesManager.getQueueProcessorEnablerRecordTypes() can be used to examine which records are supported, this method tests which record(s) are required for creating a specific QueueProcessorEnabler. Providing an empty array tests if a QueueProcessorEnabler can be created with no records.

Parameters:

queueProcessorEnablerRecordTypes - array of types

Returns:

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

Throws:

NullArgumentException - queueProcessorEnablerRecordTypes is null

Compliance:

mandatory - This method must be implemented.

getQueueProcessorEnablerFormForCreate

QueueProcessorEnablerForm getQueueProcessorEnablerFormForCreate()
                                                                throws OperationFailedException,
                                                                       PermissionDeniedException

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

Returns:

the queue processor enabler form

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

createQueueProcessorEnabler

QueueProcessorEnabler createQueueProcessorEnabler(QueueProcessorEnablerForm queueProcessorEnablerForm)
                                                  throws OperationFailedException,
                                                         PermissionDeniedException

Creates a new QueueProcessorEnabler.

Parameters:

queueProcessorEnablerForm - the form for this QueueProcessorEnabler

Returns:

the new QueueProcessorEnabler

Throws:

IllegalStateException - queueProcessorEnablerForm already used in a create transaction

InvalidArgumentException - one or more of the form elements is invalid

NullArgumentException - queueProcessorEnablerForm is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - queueProcessorEnablerForm did not originate from getQueueProcessorEnablerFormForCreate()

Compliance:

mandatory - This method must be implemented.

canUpdateQueueProcessorEnablers

boolean canUpdateQueueProcessorEnablers()

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

Compliance:

mandatory - This method must be implemented.

getQueueProcessorEnablerFormForUpdate

QueueProcessorEnablerForm getQueueProcessorEnablerFormForUpdate(Id queueProcessorEnablerId)
                                                                throws NotFoundException,
                                                                       OperationFailedException,
                                                                       PermissionDeniedException

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

Parameters:

queueProcessorEnablerId - the Id of the QueueProcessorEnabler

Returns:

the queue processor enabler form

Throws:

NotFoundException - queueProcessorEnablerId is not found

NullArgumentException - queueProcessorEnablerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

updateQueueProcessorEnabler

void updateQueueProcessorEnabler(QueueProcessorEnablerForm queueProcessorEnablerForm)
                                 throws OperationFailedException,
                                        PermissionDeniedException

Updates an existing queue processor enabler.

Parameters:

queueProcessorEnablerForm - the form containing the elements to be updated

Throws:

IllegalStateException - queueProcessorEnablerForm already used in an update transaction

InvalidArgumentException - the form contains an invalid value

NullArgumentException - queueProcessorEnablerForm is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - queueProcessorEnablerForm did not originate from getQueueProcessorEnablerFormForUpdate()

Compliance:

mandatory - This method must be implemented.

canDeleteQueueProcessorEnablers

boolean canDeleteQueueProcessorEnablers()

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

Compliance:

mandatory - This method must be implemented.

deleteQueueProcessorEnabler

void deleteQueueProcessorEnabler(Id queueProcessorEnablerId)
                                 throws NotFoundException,
                                        OperationFailedException,
                                        PermissionDeniedException

Deletes a QueueProcessorEnabler.

Parameters:

queueProcessorEnablerId - the Id of the QueueProcessorEnabler to remove

Throws:

NotFoundException - queueProcessorEnablerId not found

NullArgumentException - queueProcessorEnablerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canManageQueueProcessorEnablerAliases

boolean canManageQueueProcessorEnablerAliases()

Tests if this user can manage Id aliases for queue 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 QueueProcessorEnabler aliasing is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

aliasQueueProcessorEnabler

void aliasQueueProcessorEnabler(Id queueProcessorEnablerId,
                              Id aliasId)
                                throws AlreadyExistsException,
                                       NotFoundException,
                                       OperationFailedException,
                                       PermissionDeniedException

Adds a Id to a QueueProcessorEnabler for the purpose of creating compatibility. The primary Id of the QueueProcessorEnabler is determined by the provider. The new Id performs as an alias to the primary Id . If the alias is a pointer to another queue processor enabler. it is reassigned to the given queue processor enabler Id.

Parameters:

queueProcessorEnablerId - the Id of a QueueProcessorEnabler

aliasId - the alias Id

Throws:

AlreadyExistsException - aliasId is already assigned

NotFoundException - queueProcessorEnablerId not found

NullArgumentException - queueProcessorEnablerId or aliasId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.