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

Interface ObjectLifecycleStateUserActionMetadataService

All Superinterfaces:

Service

public interface ObjectLifecycleStateUserActionMetadataService
extends Service

Provides methods to retrieve metadata about an object lifecycle user action.

Method Summary

Modifier and Type	Method	Description
ObjectLifecycleUserActionInputParameterMetadata	getInputParameterMetadata(ObjectLifecycleUserActionInputParameterMetadataRequest request)	Retrieves an instance of ObjectLifecycleUserActionInputParameterMetadata, containing details about the user input object if the action is a RecordAction annotated with a user_input_object.
ObjectLifecycleUserActionCollectionResponse	getLifecycleUserActions(ObjectLifecycleUserActionMetadataRequest request)	Retrieves all lifecycle user actions and object actions configured for a given lifecycle state.
ObjectRecordLifecycleUserActionCollectionResponse	getRecordLifecycleUserActions(ObjectRecordLifecycleUserActionMetadataRequest request)	Retrieves all user actions and object actions configured for the object record and its lifecycle state.
ObjectLifecycleUserActionInputParameterMetadataRequest.Builder	newInputParameterMetadataRequestBuilder()	Creates an ObjectLifecycleUserActionInputParameterMetadataRequest.Builder
ObjectLifecycleUserActionMetadataRequest.Builder	newLifecycleUserActionMetadataRequestBuilder()	Creates an ObjectLifecycleUserActionMetadataRequest.Builder.
ObjectRecordLifecycleUserActionMetadataRequest.Builder	newRecordLifecycleUserActionMetadataRequestBuilder()	Creates an ObjectRecordLifecycleUserActionMetadataRequest.Builder.

Method Details

newLifecycleUserActionMetadataRequestBuilder

ObjectLifecycleUserActionMetadataRequest.Builder newLifecycleUserActionMetadataRequestBuilder()

Creates an ObjectLifecycleUserActionMetadataRequest.Builder.

Returns:

an ObjectLifecycleUserActionMetadataRequest.Builder

newRecordLifecycleUserActionMetadataRequestBuilder

ObjectRecordLifecycleUserActionMetadataRequest.Builder newRecordLifecycleUserActionMetadataRequestBuilder()

Creates an ObjectRecordLifecycleUserActionMetadataRequest.Builder.

Returns:

an ObjectRecordLifecycleUserActionMetadataRequest.Builder

newInputParameterMetadataRequestBuilder

ObjectLifecycleUserActionInputParameterMetadataRequest.Builder newInputParameterMetadataRequestBuilder()

Creates an ObjectLifecycleUserActionInputParameterMetadataRequest.Builder

Returns:

an ObjectLifecycleUserActionInputParameterMetadataRequest.Builder

getLifecycleUserActions

ObjectLifecycleUserActionCollectionResponse getLifecycleUserActions(ObjectLifecycleUserActionMetadataRequest request)

Retrieves all lifecycle user actions and object actions configured for a given lifecycle state. Requests support single object lifecycle states only. Returns object actions that are configured as user actions, or configured to be available in All Lifecycle States.

Parameters:

request - the ObjectLifecycleUserActionMetadataRequest. Lifecycle state and name must both be provided. Action type can also be optionally provided. The lifecycle with the given name must exist in the Vault. The lifecycle state with the given name must exist on the lifecycle.

Returns:

the ObjectLifecycleUserActionCollectionResponse

getRecordLifecycleUserActions

ObjectRecordLifecycleUserActionCollectionResponse getRecordLifecycleUserActions(ObjectRecordLifecycleUserActionMetadataRequest request)

Retrieves all user actions and object actions configured for the object record and its lifecycle state.

Requests support single object records only. Visibility and permission metadata for the run as user will be returned. Object actions must be configured as user actions or configured to be available in All Lifecycle States.

Parameters:

request - the ObjectLifecycleUserActionMetadataRequest. Object name and record ID must be provided. Lifecycle state and action type can also optionally be provided. An object with the provided object name and the record with the provided record ID must exist in the Vault. If provided, then the provided lifecycle state in the context must exist on the record’s lifecycle.

Returns:

the ObjectRecordLifecycleUserActionCollectionResponse

getInputParameterMetadata

ObjectLifecycleUserActionInputParameterMetadata getInputParameterMetadata(ObjectLifecycleUserActionInputParameterMetadataRequest request)

Retrieves an instance of ObjectLifecycleUserActionInputParameterMetadata, containing details about the user input object if the action is a RecordAction annotated with a user_input_object.

Object actions must be configured as user actions, or configured to be available in All Lifecycle States.
This service does not provide metadata about run workflow start step inputs. Use com.veeva.vault.sdk.api.workflow.WorkflowMetadataService#getWorkflowStartMetadata(WorkflowStartMetadataRequest) instead if that is required.

Parameters:

request - the ObjectLifecycleUserActionInputParameterMetadataRequest An object with the provided object name and the record with the provided record ID must exist in the Vault. A user action with the provided user action name must exist in the Vault. If provided, then the provided lifecycle state in the context must exist on the record’s lifecycle.

Returns:

the ObjectLifecycleUserActionInputParameterMetadata