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

Interface DocumentLifecycleUserActionMetadata

public interface DocumentLifecycleUserActionMetadata
Provides methods to retrieve metadata fields for a specific document lifecycle user action.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getDocumentActionClassName()
    For document actions, retrieves the fully qualified Java class name of the configured DocumentAction.
    String
    getLabel()
    Retrieves the label value, in the current user's language, of this document lifecycle user action.
    String
    getUserActionName()
    Retrieves the user action name of this document lifecycle user action.
    String
    getWorkflowName()
    Returns the name of the workflow associated with this user action, if this is a workflow user action.

  • Method Details

    • getLabel

      String getLabel()
      Retrieves the label value, in the current user's language, of this document lifecycle user action. This value is the label that is visible to the user in the UI.
      Returns:
      the non-null document lifecycle user action label

    • getUserActionName

      String getUserActionName()
      Retrieves the user action name of this document lifecycle user action. For example, approved__c.
      Returns:
      the document lifecycle user action name

    • getWorkflowName

      String getWorkflowName()
      Returns the name of the workflow associated with this user action, if this is a workflow user action.
      Returns:
      the name of the workflow associated with this user action, or null if this is not a workflow user action

    • getDocumentActionClassName

      String getDocumentActionClassName()
      For document actions, retrieves the fully qualified Java class name of the configured DocumentAction.
      Returns:
      the fully qualified Java class name of the configured DocumentAction, or null if this is not a document action