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

Interface ObjectLifecycleMetadataService

All Superinterfaces:

Service

public interface ObjectLifecycleMetadataService
extends Service

Provides methods to retrieve object lifecycle, state, state type, stage group, and stage metadata.

Method Summary

Modifier and Type	Method	Description
ObjectLifecycleMetadata	getLifecycle(ObjectLifecycleMetadataRequest request)	Retrieves a single ObjectLifecycleMetadata.
ObjectLifecycleMetadataCollectionResponse	getLifecycles(ObjectLifecycleMetadataCollectionRequest request)	Retrieves multiple ObjectLifecycleMetadata.
ObjectRecordLifecycleMetadata	getRecordLifecycle(ObjectRecordLifecycleMetadataRequest request)	Retrieves ObjectRecordLifecycleMetadata for a specific object record.
ObjectRecordLifecycleMetadataCollectionResponse	getRecordLifecycles(ObjectRecordLifecycleMetadataCollectionRequest request)	Retrieves the ObjectRecordLifecycleMetadata for multiple object records.
ObjectLifecycleRoleMetadata	getRole(ObjectLifecycleRoleMetadataRequest request)	Retrieves a single ObjectLifecycleRoleMetadata.
ObjectLifecycleRoleMetadataCollectionResponse	getRoles(ObjectLifecycleRoleMetadataCollectionRequest request)	Retrieves multiple ObjectLifecycleRoleMetadata.
ObjectLifecycleStageMetadata	getStage(ObjectLifecycleStageMetadataRequest request)	Retrieves a single ObjectLifecycleStageMetadata.
ObjectLifecycleStageGroupMetadata	getStageGroup(ObjectLifecycleStageGroupMetadataRequest request)	Retrieves a single ObjectLifecycleStageGroupMetadata.
ObjectLifecycleStageGroupMetadataCollectionResponse	getStageGroups(ObjectLifecycleStageGroupMetadataCollectionRequest request)	Retrieves multiple ObjectLifecycleStageGroupMetadata.
ObjectLifecycleStageMetadataCollectionResponse	getStages(ObjectLifecycleStageMetadataCollectionRequest request)	Retrieves multiple ObjectLifecycleStageMetadata.
ObjectLifecycleStateMetadata	getState(ObjectLifecycleStateMetadataRequest request)	Retrieves a single ObjectLifecycleStateMetadata.
ObjectLifecycleStateMetadataCollectionResponse	getStates(ObjectLifecycleStateMetadataCollectionRequest request)	Retrieves multiple ObjectLifecycleStateMetadata.
ObjectLifecycleStateTypeMetadata	getStateType(ObjectLifecycleStateTypeMetadataRequest request)	Retrieves a single ObjectLifecycleStateTypeMetadata.
ObjectLifecycleStateTypeMetadataCollectionResponse	getStateTypes(ObjectLifecycleStateTypeMetadataCollectionRequest request)	Retrieves multiple ObjectLifecycleStateTypeMetadata.
ObjectLifecycleMetadataCollectionRequest.Builder	newCollectionRequestBuilder()	Creates an ObjectLifecycleMetadataCollectionRequest.Builder.
ObjectRecordLifecycleMetadataCollectionRequest.Builder	newRecordLifecycleCollectionRequestBuilder()	Creates an ObjectRecordLifecycleMetadataCollectionRequest.Builder.
ObjectRecordLifecycleMetadataRequest.Builder	newRecordLifecycleRequestBuilder()	Creates an ObjectRecordLifecycleMetadataRequest.Builder.
ObjectLifecycleMetadataRequest.Builder	newRequestBuilder()	Creates an ObjectLifecycleMetadataRequest.Builder.
ObjectLifecycleRoleMetadataCollectionRequest.Builder	newRoleCollectionRequestBuilder()	Creates an ObjectLifecycleRoleMetadataCollectionRequest.Builder.
ObjectLifecycleRoleMetadataRequest.Builder	newRoleRequestBuilder()	Creates an ObjectLifecycleRoleMetadataRequest.Builder.
ObjectLifecycleStageMetadataCollectionRequest.Builder	newStageCollectionRequestBuilder()	Creates an ObjectLifecycleStageMetadataCollectionRequest.Builder.
ObjectLifecycleStageGroupMetadataCollectionRequest.Builder	newStageGroupCollectionRequestBuilder()	Creates an ObjectLifecycleStageGroupMetadataCollectionRequest.Builder.
ObjectLifecycleStageGroupMetadataRequest.Builder	newStageGroupRequestBuilder()	Creates an ObjectLifecycleStageGroupMetadataRequest.Builder.
ObjectLifecycleStageMetadataRequest.Builder	newStageRequestBuilder()	Creates an ObjectLifecycleStageMetadataRequest.Builder.
ObjectLifecycleStateMetadataCollectionRequest.Builder	newStateCollectionRequestBuilder()	Creates an ObjectLifecycleStateMetadataCollectionRequest.Builder.
ObjectLifecycleStateMetadataRequest.Builder	newStateRequestBuilder()	Creates an ObjectLifecycleStateMetadataRequest.Builder.
ObjectLifecycleStateTypeMetadataCollectionRequest.Builder	newStateTypeCollectionRequestBuilder()	Creates an ObjectLifecycleStateTypeMetadataCollectionRequest.Builder.
ObjectLifecycleStateTypeMetadataRequest.Builder	newStateTypeRequestBuilder()	Creates an ObjectLifecycleStateTypeMetadataRequest.Builder.

Method Details

newRequestBuilder

ObjectLifecycleMetadataRequest.Builder newRequestBuilder()

Creates an ObjectLifecycleMetadataRequest.Builder.

Returns:

an ObjectLifecycleMetadataRequest.Builder

getLifecycle

ObjectLifecycleMetadata getLifecycle(ObjectLifecycleMetadataRequest request)

Retrieves a single ObjectLifecycleMetadata. A valid object or lifecycle name must exist in the Vault. If both the object name and object lifecycle name are provided, then the object name must be associated with the object lifecycle name specified in the request.

Parameters:

request - the ObjectLifecycleMetadataRequest containing the information needed to retrieve the object lifecycle metadata. Cannot be null.

Returns:

an ObjectLifecycleMetadata containing the metadata of the requested object lifecycle

Throws:

RuntimeException - if the operation fails to retrieve an object lifecycle for the given object name or lifecycle name, or if the object provided in the request is not associated with the specified object lifecycle

newCollectionRequestBuilder

ObjectLifecycleMetadataCollectionRequest.Builder newCollectionRequestBuilder()

Creates an ObjectLifecycleMetadataCollectionRequest.Builder.

Returns:

an ObjectLifecycleMetadataCollectionRequest.Builder

getLifecycles

ObjectLifecycleMetadataCollectionResponse getLifecycles(ObjectLifecycleMetadataCollectionRequest request)

Retrieves multiple ObjectLifecycleMetadata.

Parameters:

request - the ObjectLifecycleMetadataCollectionRequest containing the information needed to fetch multiple object lifecycles in the format of ObjectLifecycleMetadata. Cannot be null.

Returns:

a list of ObjectLifecycleMetadata containing the metadata of the requested object lifecycles

newStateRequestBuilder

ObjectLifecycleStateMetadataRequest.Builder newStateRequestBuilder()

Creates an ObjectLifecycleStateMetadataRequest.Builder.

Returns:

an ObjectLifecycleStateMetadataRequest.Builder

getState

ObjectLifecycleStateMetadata getState(ObjectLifecycleStateMetadataRequest request)

Retrieves a single ObjectLifecycleStateMetadata. A valid object lifecycle and state name must exist in the Vault.

Parameters:

request - the ObjectLifecycleStateMetadataRequest containing the information needed to retrieve the object lifecycle state metadata. Cannot be null.

Returns:

an ObjectLifecycleStateMetadata containing the metadata of the requested object lifecycle state

Throws:

RuntimeException - if the operation fails to retrieve an object lifecycle state for the given lifecycle name and state name

newStateCollectionRequestBuilder

ObjectLifecycleStateMetadataCollectionRequest.Builder newStateCollectionRequestBuilder()

Creates an ObjectLifecycleStateMetadataCollectionRequest.Builder.

Returns:

an ObjectLifecycleStateMetadataCollectionRequest.Builder

getStates

ObjectLifecycleStateMetadataCollectionResponse getStates(ObjectLifecycleStateMetadataCollectionRequest request)

Retrieves multiple ObjectLifecycleStateMetadata. A valid object lifecycle and state type name must exist in the Vault.

Parameters:

request - the ObjectLifecycleStateMetadataCollectionRequest containing the information needed to fetch multiple object lifecycle states in the format of ObjectLifecycleStateMetadata. Cannot be null.

Returns:

a list of ObjectLifecycleStateMetadata containing the metadata of the requested object lifecycle states

newStateTypeRequestBuilder

ObjectLifecycleStateTypeMetadataRequest.Builder newStateTypeRequestBuilder()

Creates an ObjectLifecycleStateTypeMetadataRequest.Builder.

Returns:

an ObjectLifecycleStateTypeMetadataRequest.Builder

getStateType

ObjectLifecycleStateTypeMetadata getStateType(ObjectLifecycleStateTypeMetadataRequest request)

Retrieves a single ObjectLifecycleStateTypeMetadata. A valid object lifecycle and state type name must exist in the Vault.

Parameters:

request - the ObjectLifecycleStateTypeMetadataRequest containing the information needed to retrieve the object lifecycle state type metadata. Cannot be null.

Returns:

an ObjectLifecycleStateTypeMetadata containing the metadata of the requested object lifecycle state type

Throws:

RuntimeException - if the operation fails to retrieve an object lifecycle state type for the given object lifecycle name and state type name

newStateTypeCollectionRequestBuilder

ObjectLifecycleStateTypeMetadataCollectionRequest.Builder newStateTypeCollectionRequestBuilder()

Creates an ObjectLifecycleStateTypeMetadataCollectionRequest.Builder.

Returns:

an ObjectLifecycleStateTypeMetadataCollectionRequest.Builder

getStateTypes

ObjectLifecycleStateTypeMetadataCollectionResponse getStateTypes(ObjectLifecycleStateTypeMetadataCollectionRequest request)

Retrieves multiple ObjectLifecycleStateTypeMetadata. A valid object lifecycle and state name must exist in the Vault.

Parameters:

request - the ObjectLifecycleStateTypeMetadataCollectionRequest containing the information needed to fetch multiple object lifecycle state types in the format of ObjectLifecycleStateTypeMetadata. Cannot be null.

Returns:

a list of ObjectLifecycleStateTypeMetadata containing the metadata of the requested object lifecycle state types

newStageGroupRequestBuilder

ObjectLifecycleStageGroupMetadataRequest.Builder newStageGroupRequestBuilder()

Creates an ObjectLifecycleStageGroupMetadataRequest.Builder.

Returns:

an ObjectLifecycleStageGroupMetadataRequest.Builder

getStageGroup

ObjectLifecycleStageGroupMetadata getStageGroup(ObjectLifecycleStageGroupMetadataRequest request)

Retrieves a single ObjectLifecycleStageGroupMetadata. A valid object lifecycle stage group name must exist in the Vault.

Parameters:

request - the ObjectLifecycleStageGroupMetadataRequest containing the information needed to retrieve the object lifecycle stage group metadata. Cannot be null.

Returns:

an ObjectLifecycleStageGroupMetadata containing the metadata of the requested object lifecycle stage group

Throws:

RuntimeException - if the operation fails to find an object lifecycle stage group for the given name

newStageGroupCollectionRequestBuilder

ObjectLifecycleStageGroupMetadataCollectionRequest.Builder newStageGroupCollectionRequestBuilder()

Creates an ObjectLifecycleStageGroupMetadataCollectionRequest.Builder.

Returns:

an ObjectLifecycleStageGroupMetadataCollectionRequest.Builder

getStageGroups

ObjectLifecycleStageGroupMetadataCollectionResponse getStageGroups(ObjectLifecycleStageGroupMetadataCollectionRequest request)

Retrieves multiple ObjectLifecycleStageGroupMetadata. A valid object lifecycle and object type name must exist in the Vault.

Parameters:

request - the ObjectLifecycleStageGroupMetadataCollectionRequest containing the information needed to fetch multiple object lifecycle stage groups in the format of ObjectLifecycleStageGroupMetadata. Cannot be null.

Returns:

a list of ObjectLifecycleStageGroupMetadata containing the metadata of the requested object lifecycle stage groups

newStageRequestBuilder

ObjectLifecycleStageMetadataRequest.Builder newStageRequestBuilder()

Creates an ObjectLifecycleStageMetadataRequest.Builder.

Returns:

an ObjectLifecycleStageMetadataRequest.Builder

getStage

ObjectLifecycleStageMetadata getStage(ObjectLifecycleStageMetadataRequest request)

Retrieves a single ObjectLifecycleStageMetadata. A valid object lifecycle stage group and stage name must exist in the Vault.

Parameters:

request - the ObjectLifecycleStageMetadataRequest containing the information needed to retrieve the object lifecycle stage metadata. Cannot be null.

Returns:

an ObjectLifecycleStageMetadata containing the metadata of the requested object lifecycle stage

Throws:

RuntimeException - if the operation fails to find an object lifecycle stage for the given object lifecycle stage group name and stage name

newStageCollectionRequestBuilder

ObjectLifecycleStageMetadataCollectionRequest.Builder newStageCollectionRequestBuilder()

Creates an ObjectLifecycleStageMetadataCollectionRequest.Builder.

Returns:

an ObjectLifecycleStageMetadataCollectionRequest.Builder

getStages

ObjectLifecycleStageMetadataCollectionResponse getStages(ObjectLifecycleStageMetadataCollectionRequest request)

Retrieves multiple ObjectLifecycleStageMetadata. The specified object lifecycle stage group, object lifecycle, object type, and object lifecycle state name must exist in the Vault.

Parameters:

request - the ObjectLifecycleStageMetadataCollectionRequest containing the information needed to fetch multiple object lifecycle stages in the format of ObjectLifecycleStageMetadata. Cannot be null.

Returns:

a list of ObjectLifecycleStageMetadata containing the metadata of the requested object lifecycle stages

newRoleRequestBuilder

ObjectLifecycleRoleMetadataRequest.Builder newRoleRequestBuilder()

Creates an ObjectLifecycleRoleMetadataRequest.Builder.

Returns:

an ObjectLifecycleRoleMetadataRequest.Builder

getRole

ObjectLifecycleRoleMetadata getRole(ObjectLifecycleRoleMetadataRequest request)

Retrieves a single ObjectLifecycleRoleMetadata. A valid object lifecycle and role name must exist in the Vault.

Parameters:

request - the ObjectLifecycleRoleMetadataRequest containing the information needed to retrieve the object lifecycle role metadata. Cannot be null.

Returns:

an ObjectLifecycleRoleMetadata containing the metadata of the requested object lifecycle role

Throws:

RuntimeException - if the operation fails to find an object lifecycle role for the given object lifecycle name and role name

newRoleCollectionRequestBuilder

ObjectLifecycleRoleMetadataCollectionRequest.Builder newRoleCollectionRequestBuilder()

Creates an ObjectLifecycleRoleMetadataCollectionRequest.Builder.

Returns:

an ObjectLifecycleRoleMetadataCollectionRequest.Builder

getRoles

ObjectLifecycleRoleMetadataCollectionResponse getRoles(ObjectLifecycleRoleMetadataCollectionRequest request)

Retrieves multiple ObjectLifecycleRoleMetadata. A valid object lifecycle name must exist in the Vault.

Parameters:

request - the ObjectLifecycleRoleMetadataCollectionRequest containing the information needed to fetch multiple object lifecycle roles in the format of ObjectLifecycleRoleMetadata. Cannot be null.

Returns:

a list of ObjectLifecycleRoleMetadata containing the metadata of the requested object lifecycle roles

newRecordLifecycleRequestBuilder

ObjectRecordLifecycleMetadataRequest.Builder newRecordLifecycleRequestBuilder()

Creates an ObjectRecordLifecycleMetadataRequest.Builder.

Returns:

an ObjectRecordLifecycleMetadataRequest.Builder

getRecordLifecycle

ObjectRecordLifecycleMetadata getRecordLifecycle(ObjectRecordLifecycleMetadataRequest request)

Retrieves ObjectRecordLifecycleMetadata for a specific object record. A valid object name and record IDs must exist in the Vault.

Parameters:

request - the ObjectRecordLifecycleMetadataRequest containing the information needed to retrieve the object lifecycle metadata fields for a specific object record. Cannot be null.

Returns:

an ObjectRecordLifecycleMetadata containing the requested object lifecycle metadata of a specific object record

Throws:

RuntimeException - if the specified object name or record ID does not exist in the Vault, or if the specified object is not configured with an object lifecycle

newRecordLifecycleCollectionRequestBuilder

ObjectRecordLifecycleMetadataCollectionRequest.Builder newRecordLifecycleCollectionRequestBuilder()

Creates an ObjectRecordLifecycleMetadataCollectionRequest.Builder.

Returns:

an ObjectRecordLifecycleMetadataCollectionRequest.Builder

getRecordLifecycles

ObjectRecordLifecycleMetadataCollectionResponse getRecordLifecycles(ObjectRecordLifecycleMetadataCollectionRequest request)

Retrieves the ObjectRecordLifecycleMetadata for multiple object records. A valid object name and record IDs must exist in the Vault.

Parameters:

request - the ObjectRecordLifecycleMetadataCollectionRequest containing the information needed to fetch ObjectRecordLifecycleMetadata for multiple object records. Cannot be null.

Returns:

an ObjectRecordLifecycleMetadataCollectionResponse containing the requested object lifecycle metadata of multiple object records

Throws:

RuntimeException - if the specified object name or record IDs do not exist in the Vault, or if the specified object is not configured with an object lifecycle