com.hpe.caf.worker.document.model

Interface Field

All Superinterfaces:

DocumentWorkerObject

public interface Field
extends DocumentWorkerObject

Represents a field of the document. A field has a name and can have any number of values. The order of the field values is not maintained so it should not be relied upon.

Method Summary

Modifier and Type	Method and Description
void	add(byte[] data) Adds the specified binary blob value to this field.
void	add(String data) Adds the specified value to this field.
void	addReference(String dataRef) Associates data stored in the remote data store with this field.
void	clear() Removes all values from this field.
Document	getDocument() Returns the document that this field is associated with.
String	getName() Retrieves the name of the field.
List<String>	getStringValues() Returns all the non-reference field values that contain valid UTF-8 encoded strings.
FieldValues	getValues() Returns a collection of all of the values that are currently associated with this field.
boolean	hasChanges() Returns true if the field has been modified from its original state.
boolean	hasValues() Returns true if this field has some values associated with it.
void	reset() Resets the field back to its original state, undoing any changes made to it using the add() or clear() methods.
void	set(byte[] data) Sets the binary blob value in this field.
void	set(String data) Sets the value in this field.
void	setReference(String dataRef) Sets the reference in this field to the data stored in the remote data store.

Methods inherited from interface com.hpe.caf.worker.document.model.DocumentWorkerObject

getApplication

Method Detail

add

void add(String data)

Adds the specified value to this field.

To replace existing values by a new one use set(java.lang.String). The value will be stored using the UTF-8 encoding.

Parameters:

data - the value to be stored

add

void add(byte[] data)

Adds the specified binary blob value to this field. To replace existing values by a new one use set(byte[]).

Parameters:

data - the data to be stored

addReference

void addReference(String dataRef)

Associates data stored in the remote data store with this field.

To replace existing values by a new one use setReference(java.lang.String). The Worker Framework has the concept of a remote data store and fields can hold data in the data store as an alternative to passing it around using the standard messaging system. This is recommended if the data is large.

Parameters:

dataRef - the reference to the data in the remote data store

clear

void clear()

Removes all values from this field.

getDocument

@Nonnull
Document getDocument()

Returns the document that this field is associated with.

Returns:

the document that this field is associated with

getName

@Nonnull
String getName()

Retrieves the name of the field.

Returns:

the name of the field

getStringValues

@Nonnull
List<String> getStringValues()

Returns all the non-reference field values that contain valid UTF-8 encoded strings.

Returns:

the non-reference string field values

getValues

@Nonnull
FieldValues getValues()

Returns a collection of all of the values that are currently associated with this field.

Returns:

an object which can be used to iterate over the field values

hasChanges

boolean hasChanges()

Returns true if the field has been modified from its original state.

Returns:

true if the field has been modified from its original state

hasValues

boolean hasValues()

Returns true if this field has some values associated with it.

Returns:

true if this field has some values associated with it

set

void set(String data)

Sets the value in this field.

Removes existing values by clear() and adds new one by add(java.lang.String).

Parameters:

data - the value to be stored

set

void set(byte[] data)

Sets the binary blob value in this field.

Removes existing values by clear() and adds new one by add(byte[]).

Parameters:

data - the data to be stored

setReference

void setReference(String dataRef)

Sets the reference in this field to the data stored in the remote data store.

Removes existing values by clear() and adds new one by addReference(java.lang.String). The Worker Framework has the concept of a remote data store and fields can hold data in the data store as an alternative to passing it around using the standard messaging system. This is recommended if the data is large.

Parameters:

dataRef - the reference to the data in the remote data store

reset

void reset()

Resets the field back to its original state, undoing any changes made to it using the add() or clear() methods.