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

Interface DocumentActionContext

public interface DocumentActionContext
Contains contextual data about a document action during execution. For example:
  • Documents the action executes against
  • Parameters for the action, set by an Admin
  • User input, if required
To get information about the user executing the action, see RequestContext.

  • Method Details

    • getDocumentVersions

      List<DocumentVersion> getDocumentVersions()
      Retrieves the document versions this action is executing against. The values will reflect the document versions in the current transaction immediately prior to the call of the action method.

      When retrieved with this method, the DocumentVersions contain all document field values.

      Returns:
      List of document versions, containing at least one version

    • getConfigurationContext

      ConfigurationContext getConfigurationContext()
      Retrieves configuration data, such as parameter values set by an Admin, for the action being executed.
      Returns:
      configuration details for action

    • getUserInputRecord

      Record getUserInputRecord()
      Retrieves user input submitted during action execution. Returns null if this action does not require user input. User input requiredness is determined by DocumentActionInfo.
      Returns:
      the saved record if the action requires user inputs, otherwise null