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

Interface ObjectLifecycleStateMetadata

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

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getDescription()
    Retrieves the description of this object lifecycle state in the current user's language.
    String
    getLabel()
    Retrieves the label value of this object lifecycle state in the current user's language.
    String
    getName()
    Retrieves the name of this object lifecycle state.
    List<String>
    getStateTypeNames()
    Retrieves the names of all the state types associated to this object lifecycle state.
    boolean
    isActive()
    Retrieves the active status of this object lifecycle state.

  • Method Details

    • getLabel

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

    • getName

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

    • isActive

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

    • getDescription

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

    • getStateTypeNames

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