com.veeva.vault.sdk.api.document

Interface DocumentFieldCollectionResponse

public interface DocumentFieldCollectionResponse

Holds a DocumentField collection.

Method Summary

Modifier and Type	Method and Description
boolean	containsField(String fieldName) Given the field name, checks to see if an DocumentField exists with the name.
DocumentField	getField(String fieldName) Given the field name, obtains the DocumentField.
int	getFieldCount() Retrieves the number of entries in the collection.
Stream<DocumentField>	streamFields() Streams the document fields in the native format, DocumentField.

Method Detail

getField

DocumentField getField(String fieldName)

Given the field name, obtains the DocumentField. This value is never null.

Parameters:

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

Returns:

a DocumentField

containsField

boolean containsField(String fieldName)

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

Parameters:

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

Returns:

true if a DocumentField exists with the given field name, otherwise false

getFieldCount

int getFieldCount()

Retrieves the number of entries in the collection.

Returns:

the number of entries in this collection

streamFields

Stream<DocumentField> streamFields()

Streams the document fields in the native format, DocumentField.

To traverse the stream results in the classic iterator model, use the retrieved stream's BaseStream.iterator() method.

Returns:

a stream of all the DocumentField in this collection