Package com.veeva.vault.sdk.api.action

Interface ConfigurationContext

public interface ConfigurationContext
Represents contextual information for an action, such as the usage context the action is configured and executed against and parameter values set by Admins in the object configuration for the action.

  • Method Summary

    Modifier and Type
    Method
    Description
    <T> T
    getValue(String parameterName, ValueType<T> returnType)
    Retrieves a parameter's value.

  • Method Details

    • getValue

      <T> T getValue(String parameterName, ValueType<T> returnType)
      Retrieves a parameter's value.

      Supported values for parameterName parameter:

      • com.veeva.vault.sdk.api.action.Usage: the usage context in which the action is configured and executed against. Use ValueType.STRING to request data for this parameter name. The possible values include the following:
        • LIFECYCLE_ENTRY_ACTION
        • USER_ACTION
        • USER_BULK_ACTION
        • WORKFLOW_STEP
        • WORKFLOW_CANCEL
      • com.veeva.vault.sdk.api.action.UsageEntryPoint: the specific usage entry point in which the action is configured and executed against. Use ValueType.STRING to request data for this parameter name. The possible values include the following:
        • ACTION_STEP
        • CANCELATION_ACTION
        • ENTRY_ACTION
        • EVENT_ACTION
        • MULTI_RECORD_SYSTEM_ACTION_STEP
        • USER_ACTION
        • USER_BULK_ACTION
      • com.veeva.vault.sdk.api.action.UsageLabel: the label of the specific usage entry point in which the action is configured and executed against. Use ValueType.STRING to request data for this parameter name.

      This method also provides access to configuration parameter values set by Admins for the specific usage context.

      Type Parameters:
      T - type of data requested
      Parameters:
      parameterName - name of the parameter
      returnType - type of value to return
      Returns:
      the requested parameter value, or null if unavailable