com.veeva.vault.sdk.api.action

Interface DocumentAction

All Superinterfaces:

com.veeva.vault.sdk.infrastructure.core.SdkEntryPoint<DocumentActionContext>

public interface DocumentAction
extends com.veeva.vault.sdk.infrastructure.core.SdkEntryPoint<DocumentActionContext>

Executes a given document action; takes DocumentActionContext as input. A DocumentAction Class must implement this interface.

Method Summary

Modifier and Type	Method and Description
void	execute(DocumentActionContext context) The logic to execute when the action is invoked.
boolean	isExecutable(DocumentActionContext context) Determines if an action is available to users for execution.
default void	onPostExecute(PostExecutionDocumentActionUIContext context) The logic to execute after the action is invoked during the post-execution phase.
default void	onPreExecute(PreExecutionDocumentActionUIContext context) The logic to execute before the action is invoked during the pre-execution phase.

Method Detail

isExecutable

boolean isExecutable(DocumentActionContext context)

Determines if an action is available to users for execution.

Parameters:

context - indicates the target documents to execute against

Returns:

true if the action is available, otherwise false

execute

void execute(DocumentActionContext context)

The logic to execute when the action is invoked. Executes this action against the target identified in the context.

Parameters:

context - indicates the target documents to execute against

onPreExecute

default void onPreExecute(PreExecutionDocumentActionUIContext context)

The logic to execute before the action is invoked during the pre-execution phase. Used to set up action-related UI behavior to be displayed in the USER_ACTION use case when executing user actions through the UI.

Parameters:

context - to set UI data on

onPostExecute

default void onPostExecute(PostExecutionDocumentActionUIContext context)

The logic to execute after the action is invoked during the post-execution phase. Used to set up action-related UI behavior to be displayed in the USER_ACTION use case when executing user actions through the UI.

Parameters:

context - to set UI data on