org.osid.tracking.rules

Interface QueueConstrainerEnablerAdminSession

All Superinterfaces:

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

public interface QueueConstrainerEnablerAdminSession
extends OsidSession

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

Method Summary

Methods

Modifier and Type	Method and Description
void	aliasQueueConstrainerEnabler(Id queueConstrainerEnablerId, Id aliasId) Adds a Id to a QueueConstrainerEnabler for the purpose of creating compatibility.
boolean	canCreateQueueConstrainerEnabler() Tests if this user can create queue constrainer enablers.
boolean	canCreateQueueConstrainerEnablerWithRecordTypes(Type[] queueConstrainerEnablerRecordTypes) Tests if this user can create a single QueueConstrainerEnabler using the desired record types.
boolean	canDeleteQueueConstrainerEnablers() Tests if this user can delete queue constrainer enablers.
boolean	canManageQueueConstrainerEnablerAliases() Tests if this user can manage Id aliases for queue constrainer enablers.
boolean	canUpdateQueueConstrainerEnablers() Tests if this user can update queue constrainer enablers.
QueueConstrainerEnabler	createQueueConstrainerEnabler(QueueConstrainerEnablerForm queueConstrainerEnablerForm) Creates a new QueueConstrainerEnabler.
void	deleteQueueConstrainerEnabler(Id queueConstrainerEnablerId) Deletes a QueueConstrainerEnabler.
FrontOffice	getFrontOffice() Gets the FrontOffice associated with this session.
Id	getFrontOfficeId() Gets the FrontOffice Id associated with this session.
QueueConstrainerEnablerForm	getQueueConstrainerEnablerFormForCreate(Type[] queueConstrainerEnablerRecordTypes) Gets the queue constrainer enabler form for creating new queue constrainer enablers.
QueueConstrainerEnablerForm	getQueueConstrainerEnablerFormForUpdate(Id queueConstrainerEnablerId) Gets the queue constrainer enabler form for updating an existing queue constrainer enabler.
void	updateQueueConstrainerEnabler(QueueConstrainerEnablerForm queueConstrainerEnablerForm) Updates an existing queue constrainer 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

getFrontOfficeId

Id getFrontOfficeId()

Gets the FrontOffice Id associated with this session.

Returns:

the FrontOffice Id associated with this session

Compliance:

mandatory - This method must be implemented.

getFrontOffice

FrontOffice getFrontOffice()
                           throws OperationFailedException,
                                  PermissionDeniedException

Gets the FrontOffice associated with this session.

Returns:

the office

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canCreateQueueConstrainerEnabler

boolean canCreateQueueConstrainerEnabler()

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

Compliance:

mandatory - This method must be implemented.

canCreateQueueConstrainerEnablerWithRecordTypes

boolean canCreateQueueConstrainerEnablerWithRecordTypes(Type[] queueConstrainerEnablerRecordTypes)

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

Parameters:

queueConstrainerEnablerRecordTypes - array of queue constrainer enabler record types

Returns:

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

Throws:

NullArgumentException - queueConstrainerEnablerRecordTypes is null

Compliance:

mandatory - This method must be implemented.

getQueueConstrainerEnablerFormForCreate

QueueConstrainerEnablerForm getQueueConstrainerEnablerFormForCreate(Type[] queueConstrainerEnablerRecordTypes)
                                                                    throws OperationFailedException,
                                                                           PermissionDeniedException

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

Parameters:

queueConstrainerEnablerRecordTypes - array of queue constrainer enabler record types

Returns:

the queue constrainer enabler form

Throws:

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

createQueueConstrainerEnabler

QueueConstrainerEnabler createQueueConstrainerEnabler(QueueConstrainerEnablerForm queueConstrainerEnablerForm)
                                                      throws OperationFailedException,
                                                             PermissionDeniedException

Creates a new QueueConstrainerEnabler.

Parameters:

queueConstrainerEnablerForm - the form for this QueueConstrainerEnabler

Returns:

the new QueueConstrainerEnabler

Throws:

IllegalStateException - queueConstrainerEnablerForm already used in a create transaction

InvalidArgumentException - one or more of the form elements is invalid

NullArgumentException - queueConstrainerEnablerForm is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - queueConstrainerEnablerForm did not originate from getQueueConstrainerEnablerFormForCreate()

Compliance:

mandatory - This method must be implemented.

canUpdateQueueConstrainerEnablers

boolean canUpdateQueueConstrainerEnablers()

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

Compliance:

mandatory - This method must be implemented.

getQueueConstrainerEnablerFormForUpdate

QueueConstrainerEnablerForm getQueueConstrainerEnablerFormForUpdate(Id queueConstrainerEnablerId)
                                                                    throws NotFoundException,
                                                                           OperationFailedException,
                                                                           PermissionDeniedException

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

Parameters:

queueConstrainerEnablerId - the Id of the QueueConstrainerEnabler

Returns:

the queue constrainer enabler form

Throws:

NotFoundException - queueConstrainerEnablerId is not found

NullArgumentException - queueConstrainerEnablerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

updateQueueConstrainerEnabler

void updateQueueConstrainerEnabler(QueueConstrainerEnablerForm queueConstrainerEnablerForm)
                                   throws OperationFailedException,
                                          PermissionDeniedException

Updates an existing queue constrainer enabler.

Parameters:

queueConstrainerEnablerForm - the form containing the elements to be updated

Throws:

IllegalStateException - queueConstrainerEnablerForm already used in an update transaction

InvalidArgumentException - the form contains an invalid value

NullArgumentException - queueConstrainerEnablerForm is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - queueConstrainerEnablerForm did not originate from getQueueConstrainerEnablerFormForUpdate()

Compliance:

mandatory - This method must be implemented.

canDeleteQueueConstrainerEnablers

boolean canDeleteQueueConstrainerEnablers()

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

Compliance:

mandatory - This method must be implemented.

deleteQueueConstrainerEnabler

void deleteQueueConstrainerEnabler(Id queueConstrainerEnablerId)
                                   throws NotFoundException,
                                          OperationFailedException,
                                          PermissionDeniedException

Deletes a QueueConstrainerEnabler.

Parameters:

queueConstrainerEnablerId - the Id of the QueueConstrainerEnabler to remove

Throws:

NotFoundException - queueConstrainerEnablerId not found

NullArgumentException - queueConstrainerEnablerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canManageQueueConstrainerEnablerAliases

boolean canManageQueueConstrainerEnablerAliases()

Tests if this user can manage Id aliases for queue 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.

Returns:

false if QueueConstrainerEnabler aliasing is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

aliasQueueConstrainerEnabler

void aliasQueueConstrainerEnabler(Id queueConstrainerEnablerId,
                                Id aliasId)
                                  throws AlreadyExistsException,
                                         NotFoundException,
                                         OperationFailedException,
                                         PermissionDeniedException

Adds a Id to a QueueConstrainerEnabler for the purpose of creating compatibility. The primary Id of the QueueConstrainerEnabler 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 constrainer enabler. it is reassigned to the given queue constrainer enabler Id.

Parameters:

queueConstrainerEnablerId - the Id of a QueueConstrainerEnabler

aliasId - the alias Id

Throws:

AlreadyExistsException - aliasId is already assigned

NotFoundException - queueConstrainerEnablerId not found

NullArgumentException - queueConstrainerEnablerId or aliasId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.