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

Interface ObjectLifecycleUserActionMetadataRequest.Builder

Enclosing interface:

ObjectLifecycleUserActionMetadataRequest

public static interface ObjectLifecycleUserActionMetadataRequest.Builder

Method Summary

Modifier and Type	Method	Description
ObjectLifecycleUserActionMetadataRequest	build()	Retrieves a completed ObjectLifecycleUserActionMetadataRequest.
ObjectLifecycleUserActionMetadataRequest.Builder	withActionType(String actionType)	Optional: sets the name of the action type associated with the requested object lifecycle user action.
ObjectLifecycleUserActionMetadataRequest.Builder	withLifecycleName(String lifecycleName)	Required: sets the lifecycle name of the record associated with the requested object lifecycle user action.
ObjectLifecycleUserActionMetadataRequest.Builder	withLifecycleState(String stateName)	Required: sets the lifecycle state of the record associated with the requested object lifecycle user action.

Method Details

withLifecycleState

ObjectLifecycleUserActionMetadataRequest.Builder withLifecycleState(String stateName)

Required: sets the lifecycle state of the record associated with the requested object lifecycle user action.

Parameters:

stateName - lifecycle state name associated with the object lifecycle user action to retrieve metadata of.

Returns:

this ObjectLifecycleUserActionMetadataRequest.Builder

withLifecycleName

ObjectLifecycleUserActionMetadataRequest.Builder withLifecycleName(String lifecycleName)

Required: sets the lifecycle name of the record associated with the requested object lifecycle user action.

Parameters:

lifecycleName - lifecycle name associated with the object lifecycle user action to retrieve metadata of.

Returns:

this ObjectLifecycleUserActionMetadataRequest.Builder

withActionType

ObjectLifecycleUserActionMetadataRequest.Builder withActionType(String actionType)

Optional: sets the name of the action type associated with the requested object lifecycle user action. e.g. LIFECYCLE_STATE_CHANGE_ACTION if only state change actions are desired. If not provided, then default behavior is to fetch all actions, regardless of type.

Parameters:

actionType - the name of the action type

Returns:

this ObjectLifecycleUserActionMetadataRequest.Builder

build

ObjectLifecycleUserActionMetadataRequest build()

Retrieves a completed ObjectLifecycleUserActionMetadataRequest. Both lifecycle state and lifecycle name must be provided.

Returns:

this completed ObjectLifecycleUserActionMetadataRequest

Throws:

IllegalArgumentException - if any of the required values are not provided.