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

Interface ObjectLifecycleRoleMetadataCollectionResponse

public interface ObjectLifecycleRoleMetadataCollectionResponse

Holds an ObjectLifecycleRoleMetadata collection.

Method Summary

Modifier and Type	Method	Description
boolean	containsRole(String roleName)	Given the object lifecycle role name, checks to see if an ObjectLifecycleRoleMetadata exists with the name.
ObjectLifecycleRoleMetadata	getRole(String roleName)	Given the object lifecycle role name, retrieves the ObjectLifecycleRoleMetadata.
List<ObjectLifecycleRoleMetadata>	getRoles()	Retrieves all the object lifecycle roles in this collection as a list of ObjectLifecycleRoleMetadata.

Method Details

getRole

ObjectLifecycleRoleMetadata getRole(String roleName)

Given the object lifecycle role name, retrieves the ObjectLifecycleRoleMetadata. This value is never null.

Parameters:

roleName - name of the object lifecycle role. Cannot be null or empty. Object lifecycle role must exist. For example, reviewer__c

Returns:

an ObjectLifecycleRoleMetadata with the given name

Throws:

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

containsRole

boolean containsRole(String roleName)

Given the object lifecycle role name, checks to see if an ObjectLifecycleRoleMetadata exists with the name.

Parameters:

roleName - name of the object lifecycle role. Cannot be null or empty. Object lifecycle role must exist. For example, reviewer__c

Returns:

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

getRoles

List<ObjectLifecycleRoleMetadata> getRoles()

Retrieves all the object lifecycle roles in this collection as a list of ObjectLifecycleRoleMetadata.

Returns:

a list of all the ObjectLifecycleRoleMetadata in this collection