Package com.veeva.vault.sdk.api.lifecycle

Interface DocumentLifecycleMetadata

public interface DocumentLifecycleMetadata
Provides methods to retrieve metadata fields for a specific document lifecycle.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getDescription()
    Retrieves the description of this document lifecycle in the current user's language.
    String
    getLabel()
    Retrieves the label value of this document lifecycle in the current user's language.
    String
    getName()
    Retrieves the name of this document lifecycle.
    List<String>
    getRoleNames()
    Retrieves the names of all the lifecycle roles configured in this document lifecycle.
    String
    getStageGroupName()
    Retrieves the name of the stage group associated with this document lifecycle.
    List<String>
    getStateNames()
    Retrieves the names of all the states configured in this document lifecycle.
    boolean
    isActive()
    Retrieves the active status of this document lifecycle.
    boolean
    isHidden()
    Retrieves the hidden status of this document lifecycle.

  • Method Details

    • getLabel

      String getLabel()
      Retrieves the label value of this document lifecycle in the current user's language.
      Returns:
      the non-null document lifecycle label

    • getName

      String getName()
      Retrieves the name of this document lifecycle. For example, submission_ready_lifecycle__v.
      Returns:
      the non-null document lifecycle name

    • isActive

      boolean isActive()
      Retrieves the active status of this document lifecycle.
      Returns:
      true if the document lifecycle is active, otherwise false

    • isHidden

      boolean isHidden()
      Retrieves the hidden status of this document lifecycle.
      Returns:
      true if the document lifecycle is hidden, otherwise false

    • getDescription

      String getDescription()
      Retrieves the description of this document lifecycle in the current user's language.
      Returns:
      the document lifecycle description

    • getStateNames

      List<String> getStateNames()
      Retrieves the names of all the states configured in this document lifecycle. The state names are sorted in ascending order of the order field values of the document lifecycle states.
      Returns:
      List of names of all the states configured in the document lifecycle

    • getStageGroupName

      String getStageGroupName()
      Retrieves the name of the stage group associated with this document lifecycle.
      Returns:
      the name of the stage group associated with the document lifecycle, or null if the document lifecycle is not associated with any stage group

    • getRoleNames

      List<String> getRoleNames()
      Retrieves the names of all the lifecycle roles configured in this document lifecycle.
      Returns:
      List of names of all the lifecycle roles configured in the document lifecycle