Package com.veeva.vault.sdk.api.workflow

Interface WorkflowParameterMetadata

public interface WorkflowParameterMetadata
Holds the info for a parameter metadata needed to interact with the workflow.

  • Method Summary

    Modifier and Type
    Method
    Description
    WorkflowInputValueType
    getDataType()
    Retrieves the data value type of the parameter.
    String
    getLabel()
    Retrieves the label of the parameter in the user's language.
    String
    getName()
    Retrieves the name of the parameter.
    boolean
    isMultiValue()
    Retrieves whether the parameter is a multi-value input.
    boolean
    isReadOnly()
    Retrieves whether the parameter is read only.
    boolean
    isRequired()
    Retrieves whether the parameter is required to start the workflow.

  • Method Details

    • getName

      String getName()
      Retrieves the name of the parameter.
      Returns:
      name of the parameter

    • getLabel

      String getLabel()
      Retrieves the label of the parameter in the user's language.
      Returns:
      label of the parameter

    • isRequired

      boolean isRequired()
      Retrieves whether the parameter is required to start the workflow.
      Returns:
      true if the parameter is required, otherwise false

    • isMultiValue

      boolean isMultiValue()
      Retrieves whether the parameter is a multi-value input.
      Returns:
      true if the parameter is multi-valued, otherwise false

    • isReadOnly

      boolean isReadOnly()
      Retrieves whether the parameter is read only.
      Returns:
      whether the parameter is read only.

    • getDataType

      WorkflowInputValueType getDataType()
      Retrieves the data value type of the parameter.
      Returns:
      data value type of the parameter.