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

Interface ObjectLifecycleUserActionCollectionResponse

public interface ObjectLifecycleUserActionCollectionResponse

Holds an ObjectLifecycleUserActionMetadata collection.

Method Summary

Modifier and Type	Method	Description
boolean	containsUserAction(String userActionName)	Given the object lifecycle user action name, checks to see if an ObjectLifecycleUserActionMetadata exists with the name.
ObjectLifecycleUserActionMetadata	getUserAction(String userActionName)	Given the object lifecycle user action name, obtains the ObjectLifecycleUserActionMetadata.
List<ObjectLifecycleUserActionMetadata>	getUserActions()	Gets the object lifecycle user actions as a list of ObjectLifecycleUserActionMetadata.

Method Details

getUserAction

ObjectLifecycleUserActionMetadata getUserAction(String userActionName)

Given the object lifecycle user action name, obtains the ObjectLifecycleUserActionMetadata.

Parameters:

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

Returns:

an ObjectLifecycleUserActionMetadata with the given name

Throws:

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

containsUserAction

boolean containsUserAction(String userActionName)

Given the object lifecycle user action name, checks to see if an ObjectLifecycleUserActionMetadata exists with the name.

Parameters:

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

Returns:

true if an ObjectLifecycleUserActionMetadata exists with the given name, false otherwise

getUserActions

List<ObjectLifecycleUserActionMetadata> getUserActions()

Gets the object lifecycle user actions as a list of ObjectLifecycleUserActionMetadata.

Returns:

a list of all the ObjectLifecycleUserActionMetadata in this collection