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

Interface DocumentLifecycleRoleMetadataResponse

public interface DocumentLifecycleRoleMetadataResponse

Holds a DocumentLifecycleRoleMetadata collection.

Method Summary

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

Method Details

getRole

DocumentLifecycleRoleMetadata getRole(String roleName)

Given the document lifecycle role name, retrieves the DocumentLifecycleRoleMetadata. This value is never null.

Parameters:

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

Returns:

a DocumentLifecycleRoleMetadata with the given name

Throws:

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

containsRole

boolean containsRole(String roleName)

Given the document lifecycle role name, checks to see if a DocumentLifecycleRoleMetadata exists with the name.

Parameters:

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

Returns:

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

getRoles

List<DocumentLifecycleRoleMetadata> getRoles()

Retrieves all the document lifecycle roles in this collection as a List of DocumentLifecycleRoleMetadata.

Returns:

List of DocumentLifecycleRoleMetadata