com.hpe.caf.worker.document.model

Interface ResponseCustomData

All Superinterfaces:

DocumentWorkerObject

public interface ResponseCustomData
extends DocumentWorkerObject

Represents the custom data that is sent as part of the response to the document processing task.

Method Summary

Modifier and Type	Method and Description
String	get(String dataKey) Used to retrieve any custom data that has been set on the response.
Response	getResponse() Returns the response customization object that this custom data object is associated with.
String	put(String dataKey, String dataValue) Used to set custom data to be sent with the response.
void	putAll(Map<String,String> m) Used to set custom data to be sent with the response.
String	remove(String dataKey) Removes a custom data value that has been set on the response.

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

getApplication

Method Detail

getResponse

@Nonnull
Response getResponse()

Returns the response customization object that this custom data object is associated with.

Returns:

the response customization object that this custom data object is associated with

get

String get(String dataKey)

Used to retrieve any custom data that has been set on the response.

Parameters:

dataKey - the key of the data to be retrieved (note that the key lookup is case-sensitive)

Returns:

the value which has been set, or null if no value has been set with the specified key

put

String put(String dataKey,
           String dataValue)

Used to set custom data to be sent with the response. The custom data could be used to send processing instructions to the receiving worker, to affect how the document is processed by it.

Parameters:

dataKey - the key of the data to be sent with the response (note that the key is case-sensitive)

dataValue - the value to be associated with the specified key

Returns:

the previous value associated with the key, or null if there was no value previously associated with the key

putAll

void putAll(Map<String,String> m)

Used to set custom data to be sent with the response. All of the mappings from the specified map are added to the response's custom data. The effect of this call is equivalent to that of calling put(String, String) for each mapping in the specified map.

Parameters:

m - the mappings to be added to the custom data of the response

remove

String remove(String dataKey)

Removes a custom data value that has been set on the response.

Parameters:

dataKey - the key of the data to be removed from the response (note that the key is case-sensitive)

Returns:

the previous value associated with the key, or null if there was no value previously associated with the key