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

Interface DocumentLifecycleStateMetadataResponse

public interface DocumentLifecycleStateMetadataResponse

Holds a DocumentLifecycleStateMetadata collection.

Method Summary

Modifier and Type	Method	Description
boolean	containsState(String stateName)	Given the document lifecycle state name, checks to see if a DocumentLifecycleStateMetadata exists with the name.
DocumentLifecycleStateMetadata	getState(String stateName)	Given the document lifecycle state name, retrieves the DocumentLifecycleStateMetadata.
List<DocumentLifecycleStateMetadata>	getStates()	Retrieves all the document lifecycle states in this collection as a list of DocumentLifecycleStateMetadata.

Method Details

getState

DocumentLifecycleStateMetadata getState(String stateName)

Given the document lifecycle state name, retrieves the DocumentLifecycleStateMetadata. This value is never null.

Parameters:

stateName - name of the document lifecycle state. Cannot be null or empty. Document lifecycle state must exist. For example, draft_state__c.

Returns:

a DocumentLifecycleStateMetadata with the given name

Throws:

RuntimeException - if the operation fails to find a document lifecycle state for the given name in this response

containsState

boolean containsState(String stateName)

Given the document lifecycle state name, checks to see if a DocumentLifecycleStateMetadata exists with the name.

Parameters:

stateName - name of the document lifecycle state. Cannot be null or empty. For example, draft_state__c.

Returns:

true if a DocumentLifecycleStateMetadata exists with the given name, false otherwise

getStates

List<DocumentLifecycleStateMetadata> getStates()

Retrieves all the document lifecycle states in this collection as a list of DocumentLifecycleStateMetadata. The states are sorted in ascending order of their order field values.

Returns:

a list of all the DocumentLifecycleStateMetadata in this collection