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

Interface DocumentLifecycleMetadataService

All Superinterfaces:

Service

public interface DocumentLifecycleMetadataService
extends Service

Provides methods to retrieve document lifecycle, state, stage group, stage, and role metadata.

Method Summary

Modifier and Type	Method	Description
DocumentLifecycleStateEntryActionMetadataResponse	getEntryActions(DocumentLifecycleStateEntryActionMetadataRequest request)	Retrieves a DocumentLifecycleStateEntryActionMetadataResponse containing the entry action rules metadata of the requested document lifecycle state.
DocumentLifecycleStateEntryCriteriaMetadataResponse	getEntryCriteria(DocumentLifecycleStateEntryCriteriaMetadataRequest request)	Retrieves a DocumentLifecycleStateEntryCriteriaMetadataResponse containing the entry criteria rules metadata of the requested document lifecycle state.
DocumentLifecycleMetadataResponse	getLifecycles(DocumentLifecycleMetadataRequest request)	Retrieves multiple DocumentLifecycleMetadata containing the metadata of the requested document lifecycles.
DocumentLifecycleRoleMetadataResponse	getRoles(DocumentLifecycleRoleMetadataRequest request)	Retrieves multiple DocumentLifecycleRoleMetadata containing the metadata of the requested document lifecycle roles.
DocumentLifecycleStageGroupMetadataResponse	getStageGroups(DocumentLifecycleStageGroupMetadataRequest request)	Retrieves multiple DocumentLifecycleStageGroupMetadata containing the metadata of the requested document lifecycle stage groups.
DocumentLifecycleStageMetadataResponse	getStages(DocumentLifecycleStageMetadataRequest request)	Retrieves multiple DocumentLifecycleStageMetadata containing the metadata of the requested document lifecycle stages.
DocumentLifecycleStateMetadataResponse	getStates(DocumentLifecycleStateMetadataRequest request)	Retrieves multiple DocumentLifecycleStateMetadata containing the metadata of the requested document lifecycle states.
DocumentLifecycleStateEntryActionMetadataRequest.Builder	newDocumentLifecycleStateEntryActionMetadataRequestBuilder()	Creates a DocumentLifecycleStateEntryActionMetadataRequest.Builder.
DocumentLifecycleStateEntryCriteriaMetadataRequest.Builder	newDocumentLifecycleStateEntryCriteriaMetadataRequestBuilder()	Creates a DocumentLifecycleStateEntryCriteriaMetadataRequest.Builder.
DocumentLifecycleMetadataRequest.Builder	newLifecycleRequestBuilder()	Creates a DocumentLifecycleMetadataRequest.Builder.
DocumentLifecycleRoleMetadataRequest.Builder	newRoleRequestBuilder()	Creates a DocumentLifecycleRoleMetadataRequest.Builder.
DocumentLifecycleStageGroupMetadataRequest.Builder	newStageGroupRequestBuilder()	Creates a DocumentLifecycleStageGroupMetadataRequest.Builder.
DocumentLifecycleStageMetadataRequest.Builder	newStageRequestBuilder()	Creates a DocumentLifecycleStageMetadataRequest.Builder.
DocumentLifecycleStateMetadataRequest.Builder	newStateRequestBuilder()	Creates a DocumentLifecycleStateMetadataRequest.Builder.

Method Details

newLifecycleRequestBuilder

DocumentLifecycleMetadataRequest.Builder newLifecycleRequestBuilder()

Creates a DocumentLifecycleMetadataRequest.Builder.

Returns:

a DocumentLifecycleMetadataRequest.Builder

getLifecycles

DocumentLifecycleMetadataResponse getLifecycles(DocumentLifecycleMetadataRequest request)

Retrieves multiple DocumentLifecycleMetadata containing the metadata of the requested document lifecycles.

Parameters:

request - the DocumentLifecycleMetadataRequest containing the information needed to fetch multiple document lifecycles in the format of DocumentLifecycleMetadata. Cannot be null.

Returns:

List of DocumentLifecycleMetadata

newStateRequestBuilder

DocumentLifecycleStateMetadataRequest.Builder newStateRequestBuilder()

Creates a DocumentLifecycleStateMetadataRequest.Builder.

Returns:

a DocumentLifecycleStateMetadataRequest.Builder

getStates

DocumentLifecycleStateMetadataResponse getStates(DocumentLifecycleStateMetadataRequest request)

Retrieves multiple DocumentLifecycleStateMetadata containing the metadata of the requested document lifecycle states.

Parameters:

request - the DocumentLifecycleStateMetadataRequest containing the information needed to fetch multiple document lifecycle states in the format of DocumentLifecycleStateMetadata. Cannot be null.

Returns:

List of DocumentLifecycleStateMetadata

newStageGroupRequestBuilder

DocumentLifecycleStageGroupMetadataRequest.Builder newStageGroupRequestBuilder()

Creates a DocumentLifecycleStageGroupMetadataRequest.Builder.

Returns:

a DocumentLifecycleStageGroupMetadataRequest.Builder

getStageGroups

DocumentLifecycleStageGroupMetadataResponse getStageGroups(DocumentLifecycleStageGroupMetadataRequest request)

Retrieves multiple DocumentLifecycleStageGroupMetadata containing the metadata of the requested document lifecycle stage groups.

Parameters:

request - the DocumentLifecycleStageGroupMetadataRequest containing the information needed to fetch multiple document lifecycle stage groups in the format of DocumentLifecycleStageGroupMetadata. Cannot be null.

Returns:

List of DocumentLifecycleStageGroupMetadata

newStageRequestBuilder

DocumentLifecycleStageMetadataRequest.Builder newStageRequestBuilder()

Creates a DocumentLifecycleStageMetadataRequest.Builder.

Returns:

a DocumentLifecycleStageMetadataRequest.Builder

getStages

DocumentLifecycleStageMetadataResponse getStages(DocumentLifecycleStageMetadataRequest request)

Retrieves multiple DocumentLifecycleStageMetadata containing the metadata of the requested document lifecycle stages.

Parameters:

request - the DocumentLifecycleStageMetadataRequest containing the information needed to fetch multiple document lifecycle stages in the format of DocumentLifecycleStageMetadata. Cannot be null.

Returns:

List of DocumentLifecycleStageMetadata

newRoleRequestBuilder

DocumentLifecycleRoleMetadataRequest.Builder newRoleRequestBuilder()

Creates a DocumentLifecycleRoleMetadataRequest.Builder.

Returns:

a DocumentLifecycleRoleMetadataRequest.Builder

getRoles

DocumentLifecycleRoleMetadataResponse getRoles(DocumentLifecycleRoleMetadataRequest request)

Retrieves multiple DocumentLifecycleRoleMetadata containing the metadata of the requested document lifecycle roles.

Parameters:

request - the DocumentLifecycleRoleMetadataRequest containing the information needed to fetch multiple document lifecycle roles in the format of DocumentLifecycleRoleMetadata. Cannot be null.

Returns:

List of DocumentLifecycleRoleMetadata

newDocumentLifecycleStateEntryCriteriaMetadataRequestBuilder

DocumentLifecycleStateEntryCriteriaMetadataRequest.Builder newDocumentLifecycleStateEntryCriteriaMetadataRequestBuilder()

Creates a DocumentLifecycleStateEntryCriteriaMetadataRequest.Builder.

Returns:

a DocumentLifecycleStateEntryCriteriaMetadataRequest.Builder

getEntryCriteria

DocumentLifecycleStateEntryCriteriaMetadataResponse getEntryCriteria(DocumentLifecycleStateEntryCriteriaMetadataRequest request)

Retrieves a DocumentLifecycleStateEntryCriteriaMetadataResponse containing the entry criteria rules metadata of the requested document lifecycle state.

Parameters:

request - the DocumentLifecycleStateEntryCriteriaMetadataRequest containing the information needed to fetch entry criteria rule metadata for a specific document lifecycle state. Cannot be null.

Returns:

A DocumentLifecycleStateEntryCriteriaMetadataResponse

newDocumentLifecycleStateEntryActionMetadataRequestBuilder

DocumentLifecycleStateEntryActionMetadataRequest.Builder newDocumentLifecycleStateEntryActionMetadataRequestBuilder()

Creates a DocumentLifecycleStateEntryActionMetadataRequest.Builder.

Returns:

a DocumentLifecycleStateEntryActionMetadataRequest.Builder

getEntryActions

DocumentLifecycleStateEntryActionMetadataResponse getEntryActions(DocumentLifecycleStateEntryActionMetadataRequest request)

Retrieves a DocumentLifecycleStateEntryActionMetadataResponse containing the entry action rules metadata of the requested document lifecycle state.

Parameters:

request - the DocumentLifecycleStateEntryActionMetadataRequest containing the information needed to fetch the entry action rule metadata for a specific document lifecycle state. Cannot be null.

Returns:

A DocumentLifecycleStateEntryActionMetadataResponse