com.adobe.idp.taskmanager.dsc.client.queuemanager
Interface QueueManager

public interface QueueManager

Defines methods for performing queue management functions in the workflow system. It also provides shared queue administration.

Field Summary

static short	QUEUE_TYPE_GROUP Group queue type.
static short	QUEUE_TYPE_USER User queue type.

Method Summary

long	createUserQueue(UserQueue aNewQueueInfo) Creates an additional queue for the current user.
UserQueue	getEmptyUserQueue() Gets an instance of a new UserQueue object.
GroupQueue	getGroupQueue(java.lang.String aDomainName, java.lang.String aGroupCanonicalName) Creates a queue for a group.
GroupQueue[]	getGroupQueuesForUser() Retrieves a list of the group queues for a particular user for queues with an active status.
OOOProcessDesignate	getNewOOOProcessDesignate() Gets an instance of a new OOOProcessDesignate object.
OutOfOfficeDateRange	getNewOutOfOfficeDateRange() Gets an instance of a new OutOfOfficeDateRange object.
OutOfOfficeInfo	getNewOutOfOfficeInfo() Gets an instance of a new OutOfOfficeInfo object.
OutOfOfficeInfo	getOutOfOfficeSettings() Retrieves the out of office settings for the current user
OutOfOfficeInfo	getOutOfOfficeSettings(UserDef specificUser) Retrieves the current out of office settings for a specified user.
UserQueue[]	getUserQueues() Retrieves a list of the user queues for a particular user for queues with an active status.
UserSettings	getUserSettings() Deprecated. These settings are no longer used by the system.
void	grantQueueAccess(long aQueueId, java.lang.String aUserIdToGrant) Grants access to a queue for the current user.
UserDef[]	listSharedUsersForQueue(long queueId) Retrieves a list of users who have access to an active queue.
void	removeUserQueue(long aQueueToRemove) Removes the current user's queue.
void	revokeQueueAccess(long aQueueId, java.lang.String aUserToRevoke) Removes access to a queue for a specific user.
void	saveOutOfOfficeSettings(OutOfOfficeInfo oooInfo) Sets the Out of office settings for the current user.
void	saveOutOfOfficeSettings(OutOfOfficeInfo oooInfo, UserDef specificUser) Sets the Out of office settings for a specific user.
void	setUserSettings(UserSettings aSettings) Deprecated. These settings are no longer used by the system.

Field Detail

QUEUE_TYPE_USER

static final short QUEUE_TYPE_USER

User queue type.

See Also:

Constant Field Values

QUEUE_TYPE_GROUP

static final short QUEUE_TYPE_GROUP

Group queue type.

See Also:

Constant Field Values

Method Detail

grantQueueAccess

void grantQueueAccess(long aQueueId,
                      java.lang.String aUserIdToGrant)
                      throws QueueManagerException

Grants access to a queue for the current user. Only user queues can be shared. If you try to share a group queue, an exception is thrown. Exceptions are also thrown when you attempt to share a queue for a user that is already shared with that user.

Parameters:

aQueueId - The queue to share.

aUserIdToGrant - The user to which to grant access to this queue.

Throws:

QueueManagerException - if the queue to be shared is not a user queue, the queue is not found, or the queue is already shared.

revokeQueueAccess

void revokeQueueAccess(long aQueueId,
                       java.lang.String aUserToRevoke)
                       throws QueueManagerException

Removes access to a queue for a specific user. Only user queues can be called for this method. Access for user default queues cannot be removed for their default user. User queues owned by a user cannot be revoked for that user.

Parameters:

aQueueId - The queue from which to remove access.

aUserToRevoke - The user from which to remove access for this queue.

Throws:

QueueManagerException - if it is not a user queue, if the user does not already have access, or if the queue is owned by the user.

getUserQueues

UserQueue[] getUserQueues()
                          throws QueueManagerException

Retrieves a list of the user queues for a particular user for queues with an active status.

Returns:

A list of the user queues, contained in an array of UserQueue objects.

Throws:

QueueManagerException

getGroupQueuesForUser

GroupQueue[] getGroupQueuesForUser()
                                   throws QueueManagerException

Retrieves a list of the group queues for a particular user for queues with an active status.

Returns:

A list of the group queues, contained in an array of UserQueue objects.

Throws:

QueueManagerException

createUserQueue

long createUserQueue(UserQueue aNewQueueInfo)
                     throws QueueManagerException

Creates an additional queue for the current user. The owner of the newly created queue will be granted access.

Parameters:

aNewQueueInfo - Contains the queue information (including the title and description).

Returns:

The queue identifier for the newly created queue.

Throws:

QueueManagerException

getGroupQueue

GroupQueue getGroupQueue(java.lang.String aDomainName,
                         java.lang.String aGroupCanonicalName)
                         throws QueueManagerException

Creates a queue for a group. If a queue already exists for the group, the pre-existing GroupQueue will be returned.

Parameters:

aDomainName - The identifier for the domain in which the group resides.

aGroupCanonicalName - The canonical name for the group.

Returns:

The queue identifier for the newly created queue.

Throws:

QueueManagerException

removeUserQueue

void removeUserQueue(long aQueueToRemove)
                     throws QueueManagerException

Removes the current user's queue. There are certain limitations. You can only remove your own queue. You cannot remove the default queue. You cannot remove organization or skill queues.

Parameters:

aQueueToRemove - The queue to remove.

Throws:

QueueManagerException - if attempting to remove a non-user queue, a user's default queue, or a queue not owned by the user.

listSharedUsersForQueue

UserDef[] listSharedUsersForQueue(long queueId)
                                  throws QueueManagerException

Retrieves a list of users who have access to an active queue. This method is useful for a user to determine which of their queues is shared and with which other users those queues are shared, so they can administer their queue shares. The user who owns the queue is expected to always have access to the queue, so that user is not returned in the list.

Parameters:

queueId - The queue for which to return a list of users.

Returns:

A list of users who have access to the queue.

Throws:

QueueManagerException - if the user identified does not own the queue, the queue is not found, or the queue is not active.

getEmptyUserQueue

UserQueue getEmptyUserQueue()

Gets an instance of a new UserQueue object. After you populte the object with user queue settings, use it as an argument in the createUserQueue() method.

Returns:

A new UserQueue object.

See Also:

QueueManager#createUserQueue createUserQueue()]

getUserSettings

UserSettings getUserSettings()
                             throws QueueManagerException

Deprecated. These settings are no longer used by the system.

Retrieves the settings for the current user.

Returns:

The settings for the current user.

Throws:

QueueManagerException

setUserSettings

void setUserSettings(UserSettings aSettings)
                     throws QueueManagerException

Deprecated. These settings are no longer used by the system.

Changes the settings for the current user.

Parameters:

aSettings - The new settings for the current user.

Throws:

QueueManagerException

getOutOfOfficeSettings

OutOfOfficeInfo getOutOfOfficeSettings()
                                       throws QueueManagerException

Retrieves the out of office settings for the current user

Returns:

Out of office information for the current user

Throws:

QueueManagerException

getOutOfOfficeSettings

OutOfOfficeInfo getOutOfOfficeSettings(UserDef specificUser)
                                       throws QueueManagerException

Retrieves the current out of office settings for a specified user. Only administrators can make this call.

Parameters:

specificUser - A UserDef object populated with the User's ID

Returns:

Out of office information for the specified user

Throws:

QueueManagerException

saveOutOfOfficeSettings

void saveOutOfOfficeSettings(OutOfOfficeInfo oooInfo)
                             throws QueueManagerException

Sets the Out of office settings for the current user. All previous Out of office settings are overridden

Parameters:

oooInfo - A populated OutOfOfficeInfo object

Throws:

QueueManagerException

saveOutOfOfficeSettings

void saveOutOfOfficeSettings(OutOfOfficeInfo oooInfo,
                             UserDef specificUser)
                             throws QueueManagerException

Sets the Out of office settings for a specific user. All previous Out of office settings are overriden. Only administrators can make this call

Parameters:

oooInfo - A OutOfOfficeInfo object populated with the Out of office settings.

specificUser - A UserDef object populated with the User's ID.

Throws:

QueueManagerException

getNewOutOfOfficeInfo

OutOfOfficeInfo getNewOutOfOfficeInfo()

Gets an instance of a new OutOfOfficeInfo object. After you populate the object with Out of Office settings, use it as an argument in the saveOutOfOfficeSettings() or saveOutOfOfficeSettings() methods.

Returns:

getNewOutOfOfficeDateRange

OutOfOfficeDateRange getNewOutOfOfficeDateRange()

Gets an instance of a new OutOfOfficeDateRange object. After you populate the object with Out of Office date ranges, use it as an argument in the setDateRanges() method.

Returns:

getNewOOOProcessDesignate

OOOProcessDesignate getNewOOOProcessDesignate()

Gets an instance of a new OOOProcessDesignate object.

Returns: