Options
All
  • Public
  • Public/Protected
  • All
Menu

Represents a GIS workflow reference by a Site.

Hierarchy

Index

Constructors

constructor

Events

onInitializationFailed

onInitializationFailed: function

Occurs when initialization of this object fails.

Type declaration

    • (error: Error): void
    • Parameters

      • error: Error

      Returns void

onInitialized

onInitialized: function

Occurs when initialization succeeds with a response from the REST endpoint. Depending on the API, this response may actually be an error message served as a correct HTTP response.

Type declaration

    • (sender: any): void
    • Parameters

      • sender: any

      Returns void

Properties

Private _initializing

_initializing: boolean

displayName

displayName: string

The display name of the Workflow.

error

error: Error

The last error of the Workflow.

extensions

extensions: Extension[]

The extensions of the Workflow, as defined by an administrator.

externalActivities

externalActivities: any

The externalActivities of the Workflow.

id

id: string

The ID of the Workflow.

initializationFailure

initializationFailure: Error

The exception that occurred if the object could not be initialized.

isInitialized

isInitialized: boolean

Whether or not the object was successfully initialized.

properties

properties: any

The properties of the Workflow, as defined by an administrator.

runOnStartup

runOnStartup: boolean

Whether to run the Workflow on startup of the client application.

site

site: Site

The Site that the Workflow belongs to.

url

url: string

The URL that this resource was initialized from.

Methods

Private _configureObject

  • _configureObject(restObject: any, deepInitialize?: boolean): void

Private _initializationFailedHandler

  • _initializationFailedHandler(err: Error): void

Private _initializedHandler

  • _initializedHandler(sender: any): void

Private _restErrorHandler

  • _restErrorHandler(error: Error): void

Private _restLoadHandler

  • _restLoadHandler(deepInitialize: boolean, result: any): void

doWhenInitialized

  • doWhenInitialized(callback: function): void
  • doWhenInitialized(scope: any, callback: function): void
  • Parameters

    Returns void

  • Performs a callback function when this instance has been initialized. If this instance is already initialized when this function is called, the callback function will execute immediately.

    Parameters

    • scope: any

      The scope to using when executing the callback - i.e. the value of the 'this' variable in the callback function. This parameter may be ommitted in which cased the first parameter will be used as the callback function.

    • callback: function

      The callback function to execute when this instance has been initialized.

    Returns void

getInputs

  • Return an array of ArgumentInfo that represents the inputs that can be populated with values and provided to the startWorkflow method of {@link workflow.WorkflowControllerProxy}.

    Returns ArgumentInfo[]

getOutputsMetadata

  • Return an array of {@link workflow.ArgumentInfo} that represents the metadata about the outputs that will be returned when the workflow has completed. It does not contain actual running values. The real outputs will be provided by the workflowComplete method of any class implementing the {@link workflow.ActivityDispatcher} interface such as the {@link workflow.SimpleActivityDispatcher}.

    Returns ArgumentInfo[]

initialize

  • initialize(obj?: any): void
  • Initializes the {@link geocortex.essentials.AsyncInitializable}. This is an asynchronous method, you may subscribe to the onInitialized and onInitializationFailed events for completion information.

    Parameters

    • Optional obj: any

    Returns void