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

All Superinterfaces:

java.io.Serializable

public interface UserQueue
extends java.io.Serializable

Describes a user queue.

See Also:

QueueManager

Method Summary

java.lang.String	getCommonName() Retrieves the common name of the user who owns the queue.
java.util.Date	getCreateTime() Retrieves the time when the queue was created.
java.lang.String	getDescription() Retrieves the queue's description.
long	getId() Retrieves the queue identifer.
java.lang.String	getOwner() Retrieves the user identifier of the owner of this queue.
java.lang.String	getTitle() Retrieves the queue's title.
java.util.Date	getUpdatedTime() Retrieves the time when the queue was modified.
boolean	isDefaultQueueForUser() Determines whether this is the default queue for the user whose list of queues is being returned by the QueueManager.getUserQueues() method.
void	setDescription(java.lang.String aDescription) Sets the description of a queue when creating a new user queue.
void	setTitle(java.lang.String aTitle) Sets the queue's title when creating a new user queue.

Method Detail

getId

long getId()

Retrieves the queue identifer.

Returns:

The queue identifier.

getDescription

java.lang.String getDescription()

Retrieves the queue's description.

Returns:

The queue's description.

setDescription

void setDescription(java.lang.String aDescription)

Sets the description of a queue when creating a new user queue.

Parameters:

aDescription - The description of the queue to be created.

getTitle

java.lang.String getTitle()

Retrieves the queue's title.

Returns:

The queue's title.

setTitle

void setTitle(java.lang.String aTitle)

Sets the queue's title when creating a new user queue.

Parameters:

aTitle - The title of the queue to be created.

getOwner

java.lang.String getOwner()

Retrieves the user identifier of the owner of this queue.

Returns:

The user identifier of the queue owner.

isDefaultQueueForUser

boolean isDefaultQueueForUser()

Determines whether this is the default queue for the user whose list of queues is being returned by the QueueManager.getUserQueues() method.

This could be important information for a user interface that assumes that the logged in user always has a default queue and that it will be displayed differently than other queues the user has or other queues shared with that user.

Returns:

true if the queue is the default queue, false otherwise.

See Also:

QueueManager

getCreateTime

java.util.Date getCreateTime()

Retrieves the time when the queue was created.

Returns:

A Date object containing the queue's creation time.

getUpdatedTime

java.util.Date getUpdatedTime()

Retrieves the time when the queue was modified.

Returns:

A Date object containing the queue's modified time.

getCommonName

java.lang.String getCommonName()

Retrieves the common name of the user who owns the queue.

Returns:

The common name of the user.