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

Interface DocumentLifecycleUserActionMetadataResponse

public interface DocumentLifecycleUserActionMetadataResponse

Holds a DocumentLifecycleUserActionMetadata collection.

Method Summary

Modifier and Type	Method	Description
boolean	containsUserAction(String userActionName)	Given the document lifecycle user action name, checks to see if a DocumentLifecycleUserActionMetadata exists with the name.
DocumentLifecycleUserActionMetadata	getUserAction(String userActionName)	Given the document lifecycle user action name, retrieves the DocumentLifecycleUserActionMetadata.
List<DocumentLifecycleUserActionMetadata>	getUserActions()	Retrieves the document lifecycle user actions as a List of DocumentLifecycleUserActionMetadata.

Method Details

getUserAction

DocumentLifecycleUserActionMetadata getUserAction(String userActionName)

Given the document lifecycle user action name, retrieves the DocumentLifecycleUserActionMetadata.

Parameters:

userActionName - name of the document lifecycle user action. Cannot be null or empty. The document lifecycle user action must exist.

Returns:

a DocumentLifecycleUserActionMetadata with the given name

Throws:

RuntimeException - if the document lifecycle user action with the given name is not found

containsUserAction

boolean containsUserAction(String userActionName)

Given the document lifecycle user action name, checks to see if a DocumentLifecycleUserActionMetadata exists with the name.

Parameters:

userActionName - name of the document lifecycle user action. Cannot be null or empty.

Returns:

true if a DocumentLifecycleUserActionMetadata exists with the given name, false otherwise

getUserActions

List<DocumentLifecycleUserActionMetadata> getUserActions()

Retrieves the document lifecycle user actions as a List of DocumentLifecycleUserActionMetadata.

Returns:

List of DocumentLifecycleUserActionMetadata