Package com.veeva.vault.sdk.api.data

Interface ObjectFieldMetadataCollectionResponse

public interface ObjectFieldMetadataCollectionResponse

Holds an ObjectFieldMetadata collection.

Method Summary

Modifier and Type	Method	Description
boolean	containsField(String fieldName)	Given the field name, checks to see if an ObjectFieldMetadata exists with the name.
ObjectFieldMetadata	getField(String fieldName)	Given the field name, retrieves the ObjectFieldMetadata.
List<ObjectFieldMetadata>	getFields()	Retrieves a collection of ObjectFieldMetadata.

Method Details

getField

ObjectFieldMetadata getField(String fieldName)

Given the field name, retrieves the ObjectFieldMetadata.

Parameters:

fieldName - name of the field. Cannot be null or empty. Field must exist. For example, "name__v".

Returns:

a ObjectFieldMetadata

containsField

boolean containsField(String fieldName)

Given the field name, checks to see if an ObjectFieldMetadata exists with the name.

Parameters:

fieldName - name of field. Cannot be null or empty. For example, "name__v".

Returns:

true if an ObjectFieldMetadata exists with the given field name, otherwise false

getFields

List<ObjectFieldMetadata> getFields()

Retrieves a collection of ObjectFieldMetadata.

Returns:

a collection of ObjectFieldMetadata