| Package | lc.domain |
| Class | public class QueueBase |
| Inheritance | QueueBase DomainObject Object |
| Subclasses | DraftQueue, InitialQueue, Queue |
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
| Property | Defined By | ||
|---|---|---|---|
![]() | constructor : 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 | ||
![]() | prototype : Object
[static]
A reference to the prototype object of a class or function object.
| Object | |
![]() | session : 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 | ||
| Method | Defined By | ||
|---|---|---|---|
|
Constructor.
| QueueBase | ||
|
Adds a task to the queue.
| QueueBase | ||
![]() |
Indicates whether an object has a specified property defined.
| Object | |
|
Determines whether the queue is a group queue.
| QueueBase | ||
![]() |
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 | ||
![]() |
Indicates whether the specified property exists and is enumerable.
| Object | |
|
Removes a task from the queue.
| QueueBase | ||
![]() |
Sets the availability of a dynamic property for loop operations.
| Object | |
![]() |
Returns the string representation of the specified object.
| Object | |
![]() |
Returns the primitive value of the specified object.
| Object | |
| isDefault | property |
public var isDefault:Boolean = false
A flag to indicate whether the queue is default.
The default value is false.
| name | property |
public var name:String
The name of the queue.
| tasks | property |
public var tasks:ListCollectionView
The collection of tasks associated with this queue.
| type | property |
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
| QueueBase | () | Constructor |
public function QueueBase()
Constructor.
| 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.
ReturnsBoolean — 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.
ReturnsBoolean — 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.
ReturnsBoolean — 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.
|
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