org.osid.tracking.rules

Interface QueueConstrainerAdminSession

All Superinterfaces:

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

public interface QueueConstrainerAdminSession
extends OsidSession

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

Method Summary

Methods

Modifier and Type	Method and Description
void	aliasQueueConstrainer(Id queueConstrainerId, Id aliasId) Adds a Id to a QueueConstrainer for the purpose of creating compatibility.
boolean	canCreateQueueConstrainer() Tests if this user can create queue constrainers.
boolean	canCreateQueueConstrainerWithRecordTypes(Type[] queueConstrainerRecordTypes) Tests if this user can create a single QueueConstrainer using the desired record types.
boolean	canDeleteQueueConstrainers() Tests if this user can delete queue constrainers.
boolean	canManageQueueConstrainerAliases() Tests if this user can manage Id aliases for queue constrainers.
boolean	canUpdateQueueConstrainers() Tests if this user can update queue constrainers.
QueueConstrainer	createQueueConstrainer(QueueConstrainerForm queueConstrainerForm) Creates a new QueueConstrainer.
void	deleteQueueConstrainer(Id queueConstrainerId) Deletes a QueueConstrainer.
FrontOffice	getFrontOffice() Gets the FrontOffice associated with this session.
Id	getFrontOfficeId() Gets the FrontOffice Id associated with this session.
QueueConstrainerForm	getQueueConstrainerFormForCreate(Type[] queueConstrainerRecordTypes) Gets the queue constrainer form for creating new queue constrainers.
QueueConstrainerForm	getQueueConstrainerFormForUpdate(Id queueConstrainerId) Gets the queue constrainer form for updating an existing queue constrainer.
void	updateQueueConstrainer(QueueConstrainerForm queueConstrainerForm) Updates an existing queue 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

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.

canCreateQueueConstrainer

boolean canCreateQueueConstrainer()

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

Compliance:

mandatory - This method must be implemented.

canCreateQueueConstrainerWithRecordTypes

boolean canCreateQueueConstrainerWithRecordTypes(Type[] queueConstrainerRecordTypes)

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

Parameters:

queueConstrainerRecordTypes - array of queue constrainer record types

Returns:

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

Throws:

NullArgumentException - queueConstrainerRecordTypes is null

Compliance:

mandatory - This method must be implemented.

getQueueConstrainerFormForCreate

QueueConstrainerForm getQueueConstrainerFormForCreate(Type[] queueConstrainerRecordTypes)
                                                      throws OperationFailedException,
                                                             PermissionDeniedException

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

Parameters:

queueConstrainerRecordTypes - array of queue constrainer record types

Returns:

the queue constrainer form

Throws:

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

createQueueConstrainer

QueueConstrainer createQueueConstrainer(QueueConstrainerForm queueConstrainerForm)
                                        throws OperationFailedException,
                                               PermissionDeniedException

Creates a new QueueConstrainer.

Parameters:

queueConstrainerForm - the form for this QueueConstrainer

Returns:

the new QueueConstrainer

Throws:

IllegalStateException - queueConstrainerForm already used in a create transaction

InvalidArgumentException - one or more of the form elements is invalid

NullArgumentException - queueConstrainerForm is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - queueConstrainerForm did not originate from getQueueConstrainerFormForCreate()

Compliance:

mandatory - This method must be implemented.

canUpdateQueueConstrainers

boolean canUpdateQueueConstrainers()

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

Compliance:

mandatory - This method must be implemented.

getQueueConstrainerFormForUpdate

QueueConstrainerForm getQueueConstrainerFormForUpdate(Id queueConstrainerId)
                                                      throws NotFoundException,
                                                             OperationFailedException,
                                                             PermissionDeniedException

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

Parameters:

queueConstrainerId - the Id of the QueueConstrainer

Returns:

the queue constrainer form

Throws:

NotFoundException - queueConstrainerId is not found

NullArgumentException - queueConstrainerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

updateQueueConstrainer

void updateQueueConstrainer(QueueConstrainerForm queueConstrainerForm)
                            throws OperationFailedException,
                                   PermissionDeniedException

Updates an existing queue constrainer.

Parameters:

queueConstrainerForm - the form containing the elements to be updated

Throws:

IllegalStateException - queueConstrainerForm already used in an update transaction

InvalidArgumentException - the form contains an invalid value

NullArgumentException - queueConstrainerForm is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

UnsupportedException - queueConstrainerForm did not originate from getQueueConstrainerFormForUpdate()

Compliance:

mandatory - This method must be implemented.

canDeleteQueueConstrainers

boolean canDeleteQueueConstrainers()

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

Compliance:

mandatory - This method must be implemented.

deleteQueueConstrainer

void deleteQueueConstrainer(Id queueConstrainerId)
                            throws NotFoundException,
                                   OperationFailedException,
                                   PermissionDeniedException

Deletes a QueueConstrainer.

Parameters:

queueConstrainerId - the Id of the QueueConstrainer to remove

Throws:

NotFoundException - queueConstrainerId not found

NullArgumentException - queueConstrainerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canManageQueueConstrainerAliases

boolean canManageQueueConstrainerAliases()

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

Compliance:

mandatory - This method must be implemented.

aliasQueueConstrainer

void aliasQueueConstrainer(Id queueConstrainerId,
                         Id aliasId)
                           throws AlreadyExistsException,
                                  NotFoundException,
                                  OperationFailedException,
                                  PermissionDeniedException

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

Parameters:

queueConstrainerId - the Id of a QueueConstrainer

aliasId - the alias Id

Throws:

AlreadyExistsException - aliasId is already assigned

NotFoundException - queueConstrainerId not found

NullArgumentException - queueConstrainerId or aliasId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.