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

Interface ObjectLifecycleUserActionMetadata

public interface ObjectLifecycleUserActionMetadata
Provides methods to retrieve metadata fields for a specific object lifecycle user action.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getFullyQualifiedActionName()
    Retrieves the fully qualified action name, in the format of: Objectaction.vobjectName.actionName, or Objectlifecyclestateuseraction.vobjectName.stateName.actionName.
    String
    getLabel()
    Retrieves the label value, in the current user's language, of this object lifecycle user action.
    String
    getName()
    Retrieves the component name of this object lifecycle user action.
    String
    getRecordActionClassName()
    For object actions, retrieves the fully qualified Java class name of the configured RecordAction.
    String
    getType()
    Retrieves the type of this object lifecycle user action, or null if the action is an object action configured on all lifecycle states.
    String
    getUserActionName()
    Retrieves the user action name of this object 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 object lifecycle user action. This value is the label that is visible to the user in the UI.
      Returns:
      the non-null object lifecycle user action label.

    • getName

      String getName()
      Retrieves the component name of this object lifecycle user action. e.g. Objectlifecyclestateuseraction or Objectaction.
      Returns:
      the non-null object lifecycle user action component name.

    • getUserActionName

      String getUserActionName()
      Retrieves the user action name of this object lifecycle user action. e.g. change_state_to_active_useraction__c
      Returns:
      the object lifecycle user action name.

    • getType

      String getType()
      Retrieves the type of this object lifecycle user action, or null if the action is an object action configured on all lifecycle states. e.g. LIFECYCLE_RUN_WORKFLOW_ACTION or LIFECYCLE_STATE_CHANGE_ACTION for a run workflow or state change user action, or Objectaction.object__c.action__c for an object action configured on a particular state.
      Returns:
      the object lifecycle user action type, or null if the action is an object action configured on all lifecycle states.

    • 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.

    • getRecordActionClassName

      String getRecordActionClassName()
      For object actions, retrieves the fully qualified Java class name of the configured RecordAction.
      Returns:
      the fully qualified Java class name of the configured RecordAction, or null if this is not an object action.

    • getFullyQualifiedActionName

      String getFullyQualifiedActionName()
      Retrieves the fully qualified action name, in the format of: Objectaction.vobjectName.actionName, or Objectlifecyclestateuseraction.vobjectName.stateName.actionName.
      Returns:
      the fully qualified action name.