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

Interface ObjectLifecycleStateMetadataCollectionResponse

public interface ObjectLifecycleStateMetadataCollectionResponse

Holds an ObjectLifecycleStateMetadata collection.

Method Summary

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

Method Details

getState

ObjectLifecycleStateMetadata getState(String stateName)

Given the object lifecycle state name, retrieves the ObjectLifecycleStateMetadata. This value is never null.

Parameters:

stateName - name of the object lifecycle state. Cannot be null or empty. Object lifecycle state must exist. For example, initiated_state__c

Returns:

an ObjectLifecycleStateMetadata with the given name

Throws:

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

containsState

boolean containsState(String stateName)

Given the object lifecycle state name, checks to see if an ObjectLifecycleStateMetadata exists with the name.

Parameters:

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

Returns:

true if an ObjectLifecycleStateMetadata exists with the given name, false otherwise

getStates

List<ObjectLifecycleStateMetadata> getStates()

Retrieves all the object lifecycle states in this collection as a list of ObjectLifecycleStateMetadata.

Returns:

a list of all the ObjectLifecycleStateMetadata in this collection