Packagelc.domain
Classpublic class Category
InheritanceCategory Inheritance DomainObject Inheritance Object
Subclasses FavoriteCategory

The Category class manages all category information. A category represents the collection of endpoints. The collection of endpoints is loaded when required. The set of endpoints for each category is configured in Archive Administration in LiveCycle Administration Console.

The Category class is typically used to present a list of endpoints to a user for starting a process.

See also

lc.domain.Endpoint


Public Properties
 PropertyDefined By
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
  description : String
The description of the category.
Category
  endpoints : ListCollectionView = null
A collection of endpoints for a category.
Category
  filled : Boolean
[read-only] Indicates whether the endpoints are available.
Category
  name : String
The name of the category.
Category
 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
Public Methods
 MethodDefined By
 Inherited
Indicates whether an object has a specified property defined.
Object
 Inherited
Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.
Object
  
Loads the endpoints collection into the Category object.
Category
 Inherited
Indicates whether the specified property exists and is enumerable.
Object
 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
descriptionproperty
description:String  [read-write]

The description of the category.


Implementation
    public function get description():String
    public function set description(value:String):void
endpointsproperty 
public var endpoints:ListCollectionView = null

A collection of endpoints for a category. The collection of endpoints are available only after calling the loadEndpoints method.

The default value is null.

filledproperty 
filled:Boolean  [read-only]

Indicates whether the endpoints are available.


Implementation
    public function get filled():Boolean
nameproperty 
name:String  [read-write]

The name of the category.


Implementation
    public function get name():String
    public function set name(value:String):void
Method Detail
loadEndpoints()method
public function loadEndpoints():Token

Loads the endpoints collection into the Category object. The endpoints collection will be a value of null until this method is called.

Returns
Token — A token that contains handlers to asynchronous calls.




 

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/Category.html