Package com.veeva.vault.sdk.api.document

Interface DocumentFieldMetadataResponse

public interface DocumentFieldMetadataResponse

Holds a collection of DocumentFieldMetadata entries.

Method Summary

Modifier and Type	Method	Description
boolean	containsField(String fieldName)	Given a field name, checks to see if the corresponding DocumentFieldMetadata object exists within this response.
DocumentFieldMetadata	getField(String fieldName)	Given the field name, retrieves the corresponding DocumentFieldMetadata object.
List<DocumentFieldMetadata>	getFields()	Retrieves a collection of all DocumentFieldMetadata objects contained within this response.

Method Details

getField

DocumentFieldMetadata getField(String fieldName)

Given the field name, retrieves the corresponding DocumentFieldMetadata object.

Parameters:

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

Returns:

a DocumentFieldMetadata

getFields

List<DocumentFieldMetadata> getFields()

Retrieves a collection of all DocumentFieldMetadata objects contained within this response.

Returns:

a collection of DocumentFieldMetadata

containsField

boolean containsField(String fieldName)

Given a field name, checks to see if the corresponding DocumentFieldMetadata object exists within this response.

Parameters:

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

Returns:

true if a corresponding DocumentFieldMetadata object exists within this response, otherwise false