Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • DefaultActivityDispatcher

Implements

Index

Constructors

constructor

  • new DefaultActivityDispatcher(): DefaultActivityDispatcher
  • new DefaultActivityDispatcher(errorHandler: function, activityBeginHandler: function, activityCompleteHandler: function, workflowCompleteHandler: function): DefaultActivityDispatcher
  • new DefaultActivityDispatcher(errorHandler: function, activityBeginHandler: function, activityCompleteHandler: function, workflowCompleteHandler: function, workflowAbortHandler: function, webRequestBeginHandler: function, webRequestCompleteHandler: function): DefaultActivityDispatcher
  • Initializes a new instance of the {@link geocortex.workflow.DefaultActivityDispatcher} class.

    class

    The default activity dispatcher for workflow. Use or subclass this dispatcher to handle all built-in activities.

    constructs

    Returns DefaultActivityDispatcher

  • Initializes a new instance of the {@link geocortex.workflow.DefaultActivityDispatcher} class.

    Parameters

    • errorHandler: function
    • activityBeginHandler: function
        • (context: any): void
        • Parameters

          • context: any

          Returns void

    • activityCompleteHandler: function
        • (context: any): void
        • Parameters

          • context: any

          Returns void

    • workflowCompleteHandler: function
        • (outputs: any, workflow: Workflow): void
        • Parameters

          Returns void

    Returns DefaultActivityDispatcher

  • Initializes a new instance of the {@link geocortex.workflow.DefaultActivityDispatcher} class.

    Parameters

    • errorHandler: function
    • activityBeginHandler: function
        • (context: any): void
        • Parameters

          • context: any

          Returns void

    • activityCompleteHandler: function
        • (context: any): void
        • Parameters

          • context: any

          Returns void

    • workflowCompleteHandler: function
        • (outputs: any, workflow: Workflow): void
        • Parameters

          Returns void

    • workflowAbortHandler: function
        • (context: any, workflow: Workflow): void
        • Parameters

          Returns void

    • webRequestBeginHandler: function
        • (url: string, workflow: Workflow): void
        • Parameters

          Returns void

    • webRequestCompleteHandler: function
        • (url: string, workflow: Workflow): void
        • Parameters

          Returns void

    Returns DefaultActivityDispatcher

Properties

_showDebugHandler

_showDebugHandler: function

Type declaration

    • (formDefinition: any, callback: any): any
    • Parameters

      • formDefinition: any
      • callback: any

      Returns any

Private defaultFormContainerId

defaultFormContainerId: string

defaultFormContentId

defaultFormContentId: string

handleOpenReportUrlFunction

handleOpenReportUrlFunction: function

Type declaration

handleUnhandledActivityErrorFunction

handleUnhandledActivityErrorFunction: function

Type declaration

isBusy

isBusy: boolean

The value indicating whether the workflow controller is busy.

type

Boolean

Methods

abortMapBasedActivity

  • abortMapBasedActivity(): boolean
  • Aborts any workflow activity that requires map interaction. e.g. CaptureGeometry.

    Returns boolean

    A boolean value indicating if any active draw activity has been successfully cancelled or not

activityAbort

  • Called when the client portion of an external activity is aborted for some reason. This will invoke the workflowAbortHandler since the workflow can no longer continue once a component activity is aborted.

    Parameters

    Returns void

activityBegin

  • Called when the client portion of an external activity is about to be dispatched. This will invoke the activityBeginHandler.

    Parameters

    • context: ActivityContext

      The context of the activity that is about to begin.

    Returns void

activityComplete

  • Called when the client portion of an external activity is complete. This will invoke the activityCompleteHandler.

    Parameters

    • context: ActivityContext

      The context of the activity that has just completed.

    Returns void

canHandleActivity

  • Determines whether this instance can handle the specified ActivityContext.

    Parameters

    Returns boolean

dispatch

  • Performs the dispatching of an external activity. This will invoke the dispatchHandler.

    Parameters

    Returns void

handleError

  • Handles error related to workflows. This will invoke the errorHandler.

    Parameters

    • error: Error

      The error to handle.

    • activityContext: ActivityContext

      The ActivityContext that generated the error.

    Returns void

handleOpenReportUrl

handleUnhandledActivityError

  • handleUnhandledActivityError(error: Error, activityContext: ActivityContext): void
  • Parameters

    Returns void

registerActivityHandler

  • registerActivityHandler(activityTypeName: string, handler: Function): void
  • Registers a handler that will be called when an activity with a matching type name is encountered. Note that a handler with a matching external Id overrides a matching type name.

    Parameters

    • activityTypeName: string
    • handler: Function

    Returns void

registerDefaultHandlers

  • registerDefaultHandlers(): void
  • Registers default handler behaviour.

    Returns void

registerExternalIdHandler

  • registerExternalIdHandler(externalId: string, handler: Function): void
  • Registers a handler that will be called by the dispatcher if an activity with a matching external Id is encountered. This allows the workflow developer to target a specific activity within a specific workflow instead of handling it based on the more general type name. Note that a handler with a matching external Id overrides a matching type name.

    Parameters

    • externalId: string

      The Id of the activity to register handler for.

    • handler: Function

      The handler to register for the given activity.

    Returns void

setDrawObjectContext

  • setDrawObjectContext(ctx: object): void
  • Sets the value of the DrawObjectContext

    Parameters

    • ctx: object

    Returns void

webRequestBegin

  • webRequestBegin(url: string, workflow: Workflow): void
  • Called when a web request is started as part of a workflow.

    Parameters

    • url: string

      The web request URL.

    • workflow: Workflow

      The current workflow.

    Returns void

webRequestComplete

  • webRequestComplete(url: string, workflow: Workflow): void
  • Called when a web request is completed as part of a workflow.

    Parameters

    • url: string

      The web request URL.

    • workflow: Workflow

      The current workflow.

    Returns void

workflowAbort

  • Called if the workflow is aborted.

    Parameters

    • context: ActivityContext

      The context of the activity that has caused the workflow to abort

    • workflow: Workflow

      The workflow that has just been aborted

    Returns void

workflowComplete

  • workflowComplete(outputs: any, workflow: Workflow): void
  • Called when the workflow is complete.

    Parameters

    • outputs: any

      The outputs of the workflow that has just completed. This will invoke the workflowCompleteHandler.

    • workflow: Workflow

      The workflow that has just completed.

    Returns void