Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • Saveable
    • WorkflowInputParameter

Implements

Index

Constructors

constructor

Properties

Optional collection_type

collection_type?: string

Collection type (defaults to list if type is collection). Nested collection types are separated with colons, e.g. list:list:paired.

Optional default_

default_?: any

The default value to use for this parameter if the parameter is missing from the input object, or if the value of the parameter in the input object is null. Default values are applied before evaluating expressions (e.g. dependent valueFrom fields).

Optional doc

doc?: string | string[]

A documentation string for this object, or an array of strings which should be concatenated.

Optional extensionFields

extensionFields?: Dictionary<any>

Optional format

format?: string[]

Specify datatype extension for valid input datasets.

Optional id

id?: string

The unique identifier for this object.

Optional label

label?: string

A short, human-readable label of this object.

loadingOptions

loadingOptions: LoadingOptions

Optional optional

optional?: boolean

If set to true, WorkflowInputParameter is not required to submit the workflow.

Optional position

position?: StepPosition

Optional type

type?: string

Specify valid types of data that may be assigned to this parameter.

Static attr

attr: Set<string> = ...

Methods

save

  • save(top?: boolean, baseUrl?: string, relativeUris?: boolean): Dictionary<any>
  • Parameters

    • top: boolean = false
    • baseUrl: string = ''
    • relativeUris: boolean = true

    Returns Dictionary<any>

Static fromDoc

  • fromDoc(__doc: any, baseuri: string, loadingOptions: LoadingOptions, docRoot?: string): Promise<Saveable>
  • Used to construct instances of .

    throws

    ValidationException If the document fragment is not a {@link Dictionary} or validation of fields fails.

    Parameters

    • __doc: any

      Document fragment to load this record object from.

    • baseuri: string

      Base URI to generate child document IDs against.

    • loadingOptions: LoadingOptions

      Context for loading URIs and populating objects.

    • Optional docRoot: string

      ID at this position in the document (if available)

    Returns Promise<Saveable>

    An instance of

Generated using TypeDoc