Packagelc.domain
Classpublic class Endpoint
InheritanceEndpoint Inheritance DomainObject Inheritance Object

The Endpoint class represents an endpoint in LiveCycle ES. An Endpoint object is used for the following purposes:
  • Retrieving the properties of the endpoint.
  • Starting a process instance and the corresponding tasks by invoking an endpoint. For the user's perspective, a process is started by using a form.

    • See also

    lc.domain.ProcessInstance
    lc.domain.Task

    Public Properties
     PropertyDefined By
      categoryId : String
    The identifier of the category that owns this endpoint.
    		Endpoint
     Inheritedconstructor : Object
    A reference to the class object or constructor function for a given object instance.
    		Object
      description : String
    The description of the endpoint.
    		Endpoint
      endpointId : String
    The endpoint identifier.
    		Endpoint
      name : String
    The name of the endpoint or form used to start a process.
    		Endpoint
     Inheritedprototype : Object
    [static] A reference to the prototype object of a class or function object.
    		Object
      service : String
    		Endpoint
     Inheritedsession : SessionMap
    [read-only] A SessionMap object that stores information relating to the server session.
    		DomainObject
    Public Methods
     MethodDefined By
     Inherited
    hasOwnProperty(name:String):Boolean
    Indicates whether an object has a specified property defined.
    		Object
      
    invoke():ObjectToken
    Invokes the specified endpoint.
    		Endpoint
     Inherited
    isPrototypeOf(theClass:Object):Boolean
    Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.
    		Object
     Inherited
    propertyIsEnumerable(name:String):Boolean
    Indicates whether the specified property exists and is enumerable.
    		Object
     Inherited
    setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void
    Sets the availability of a dynamic property for loop operations.
    		Object
      
    setSession(session:SessionMap):void
    Sets a SessionMap object that stores the information relating to the server session.
    		Endpoint
     Inherited
    toString():String
    Returns the string representation of the specified object.
    		Object
     Inherited
    valueOf():Object
    Returns the primitive value of the specified object.
    		Object
    Property Detail
    categoryIdproperty
    categoryId:String  [read-write]

    The identifier of the category that owns this endpoint.


    Implementation
        public function get categoryId():String
        public function set categoryId(value:String):void

    See also

    Category
    descriptionproperty 
    description:String  [read-write]

    The description of the endpoint.


    Implementation
        public function get description():String
        public function set description(value:String):void
    endpointIdproperty 
    endpointId:String  [read-write]

    The endpoint identifier.


    Implementation
        public function get endpointId():String
        public function set endpointId(value:String):void
    nameproperty 
    name:String  [read-write]

    The name of the endpoint or form used to start a process.


    Implementation
        public function get name():String
        public function set name(value:String):void
    serviceproperty 
    service:String  [read-write]


    Implementation
        public function get service():String
        public function set service(value:String):void
    Method Detail
    invoke()method
    public function invoke():ObjectToken

    Invokes the specified endpoint. If the endpoint returns a document, a DocumentReference object will be returned. If the endpoint returns task information, a Task object will be returned.

    Returns
    ObjectToken — An ObjectToken object that contains the endpoint invocation result as a Task or DocumentReference object when the request completes.

    See also

    lc.core.IEndpointManager.invokeEndpoint()
    setSession()method 
    public override function setSession(session:SessionMap):void

    Sets a SessionMap object that stores the information relating to the server session.

    Parameters

    session:SessionMap — Specifies the information relating to the server session.




    © 2004-2007 Adobe Systems Incorporated. All rights reserved.
    Sun Sep 23 2007, 10:15 PM GMT-07:00

     

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