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

Interface ObjectLifecycleMetadata

public interface ObjectLifecycleMetadata
Provides methods to retrieve metadata fields for a specific object lifecycle.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getDescription()
    Retrieves the description of this object lifecycle in the current user's language.
    String
    getLabel()
    Retrieves the label value of this object lifecycle in the current user's language.
    String
    getName()
    Retrieves the name of this object lifecycle.
    String
    getObjectName()
    Retrieves the name of the object associated with this object lifecycle.
    List<String>
    getRoleNames()
    Retrieves the names of all the lifecycle roles configured in this object lifecycle.
    List<String>
    getStageGroupNames()
    Retrieves the names of all the stage groups associated with this object lifecycle.
    List<String>
    getStateNames()
    Retrieves the names of all the states configured in this object lifecycle.
    List<String>
    getStateTypeNames()
    Retrieves the names of the state types configured in this object lifecycle.
    boolean
    isActive()
    Retrieves the active status of this object lifecycle.

  • Method Details

    • getLabel

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

    • getName

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

    • isActive

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

    • getDescription

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

    • getObjectName

      String getObjectName()
      Retrieves the name of the object associated with this object lifecycle.
      Returns:
      the name of the object associated with the object lifecycle, or null if this object lifecycle is not associated with any object. For example, checklist__sys

    • getStateNames

      List<String> getStateNames()
      Retrieves the names of all the states configured in this object lifecycle.
      Returns:
      a list of names of all the states configured in the object lifecycle

    • getStateTypeNames

      List<String> getStateTypeNames()
      Retrieves the names of the state types configured in this object lifecycle.
      Returns:
      a list of names of all the state types configured in the object lifecycle

    • getStageGroupNames

      List<String> getStageGroupNames()
      Retrieves the names of all the stage groups associated with this object lifecycle.
      Returns:
      a list of names of all the stage groups associated with the object lifecycle

    • getRoleNames

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