Package com.veeva.vault.sdk.api.workflow

Interface AvailableWorkflowMetadataCollectionResponse

public interface AvailableWorkflowMetadataCollectionResponse

Holds a list of AvailableWorkflowMetadata.

Method Summary

Modifier and Type	Method	Description
boolean	containsWorkflow(String workflowName)	Given the workflow name, checks to see if an AvailableWorkflowMetadata exists with the name.
AvailableWorkflowMetadata	getWorkflow(String workflowName)	Given the workflow name, obtains the AvailableWorkflowMetadata.
List<AvailableWorkflowMetadata>	getWorkflows()	Retrieves the list of AvailableWorkflowMetadata.

Method Details

getWorkflow

AvailableWorkflowMetadata getWorkflow(String workflowName)

Given the workflow name, obtains the AvailableWorkflowMetadata. This value is never null.

Parameters:

workflowName - public key name of the workflow. Cannot be null or empty. Workflow name must exist. For example, review_workflow__c.

Returns:

AvailableWorkflowMetadata for the workflow

containsWorkflow

boolean containsWorkflow(String workflowName)

Given the workflow name, checks to see if an AvailableWorkflowMetadata exists with the name.

Parameters:

workflowName - public key name of the workflow. Cannot be null or empty. Workflow name must exist. For example, review_workflow__c.

Returns:

true if the workflow is in this collection, otherwise false

getWorkflows

List<AvailableWorkflowMetadata> getWorkflows()

Retrieves the list of AvailableWorkflowMetadata.

Returns:

a list of all the AvailableWorkflowMetadata