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

Interface DocumentLifecycleStateMetadata

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

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getDescription()
    Retrieves the description of this document lifecycle state in the current user's language.
    String
    getLabel()
    Retrieves the label value of this document lifecycle state in the current user's language.
    String
    getName()
    Retrieves the name of this document lifecycle state.
    int
    getOrder()
    Retrieves the order of this document lifecycle state.
    boolean
    isActive()
    Retrieves the active status of this document lifecycle state.

  • Method Details

    • getLabel

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

    • getName

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

    • isActive

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

    • getDescription

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

    • getOrder

      int getOrder()
      Retrieves the order of this document lifecycle state.
      Returns:
      the document lifecycle state order