Packagelc.domain
Classpublic class QueueBase
InheritanceQueueBase Inheritance DomainObject Inheritance Object
Subclasses DraftQueue, InitialQueue, Queue

The QueueBase class manages a collection of Task objects. This class should not be used directly; its functionality is available through one of its subclasses.

See also

lc.domain.Queue
lc.domain.InitialQueue
lc.domain.DraftQueue


Public Properties
 PropertyDefined By
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
  isDefault : Boolean = false
A flag to indicate whether the queue is default.
QueueBase
  name : String
The name of the queue.
QueueBase
 Inheritedprototype : Object
[static] A reference to the prototype object of a class or function object.
Object
 Inheritedsession : SessionMap
[read-only] A SessionMap object that stores information relating to the server session.
DomainObject
  tasks : ListCollectionView
The collection of tasks associated with this queue.
QueueBase
  type : Number
The type of the queue.
QueueBase
Public Methods
 MethodDefined By
  
Constructor.
QueueBase
  
addTask(task:Task):void
Adds a task to the queue.
QueueBase
 Inherited
Indicates whether an object has a specified property defined.
Object
  
Determines whether the queue is a group queue.
QueueBase
 Inherited
Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.
Object
  
Determines whether the queue is a shared queue.
QueueBase
  
Determines whether the queue is the user's queue.
QueueBase
 Inherited
Indicates whether the specified property exists and is enumerable.
Object
  
Removes a task from the queue.
QueueBase
 Inherited
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
Returns the string representation of the specified object.
Object
 Inherited
Returns the primitive value of the specified object.
Object
Property Detail
isDefaultproperty
public var isDefault:Boolean = false

A flag to indicate whether the queue is default.

The default value is false.

nameproperty 
public var name:String

The name of the queue.

tasksproperty 
public var tasks:ListCollectionView

The collection of tasks associated with this queue.

typeproperty 
public var type:Number

The type of the queue. It may be one of the following values, QueueConstants.USER, QueueConstants.GROUP, QueueConstants.SHARED.

See also

Constructor Detail
QueueBase()Constructor
public function QueueBase()

Constructor.

Method Detail
addTask()method
public function addTask(task:Task):void

Adds a task to the queue.

Parameters

task:Task — Specifies the task to be added.

isGroupQueue()method 
public function isGroupQueue():Boolean

Determines whether the queue is a group queue.

Returns
Boolean — A flag that indicates whether it is a group queue. A value of true indicates that the queue is a group queue.
isSharedQueue()method 
public function isSharedQueue():Boolean

Determines whether the queue is a shared queue.

Returns
Boolean — A flag that indicates whether the queue is shared. A value of true indicates that the queue is shared.
isUserQueue()method 
public function isUserQueue():Boolean

Determines whether the queue is the user's queue.

Returns
Boolean — A flag that indicates whether the queue is the user's queue. A value of true indicates that the queue is the user's queue.
removeTask()method 
public function removeTask(task:Task):Task

Removes a task from the queue.

Parameters

task:Task — Specifies the task to be removed.

Returns
Task




 

Send me an e-mail when comments are added to this page | Comment Report

Current page: http://livedocs.adobe.com/livecycle/es/sdkHelp/common/langref/lc/domain/QueueBase.html