com.hcl.domino.keep.dbrequests.pim

Class AdditionalFieldsHelper

java.lang.Object

com.hcl.domino.keep.dbrequests.pim.AdditionalFieldsHelper

public class AdditionalFieldsHelper
extends java.lang.Object

Utility class for APIs to be able to create, read and update a single field

that contains JSON metadata that the client creates and can consume.

This utility will facilitate adding, updating and retrieving this JSON.

The purpose of this functionality is to allow the consumer to create metadata

without creating potentially conflicting fields on a document. All the JSON

is stored in 1 document field named $$K_AdditionalFields.

When a client wants to add this metadata within the body of request, IE

create or update they add a new JSON Object named AdditionalFields to their

request Body, for example: AdditionalFields : { “Field1” : “First Field”,

“Field2” : “Second Field”, “Field3” : “Third Field” }

That same object is returned when getting the fields from a document.

For writing AdditionalFields, If the individual API uses

createDocumentFromPayload or updateDocFromPayload, no intervention is

necessary as long as the AdditionalFields object is in the incoming.

For reading a document’s fields, no work needs to be done to create the

AdditionalFields object if the API is calling document2Json.

If the API does not use one of those functions, they can use this helper to

get add or update the document.

What this helper does is add or update a Text field to the document, that

text field is named : $$K_AdditionalFields This field contains the JSON of

the Object minus the object name, IE: { “Field1” : “First Field”, “Field2”

“Second Field”, “Field3” : “Third Field” }

If the document being updated already has a the $$K_AdditionalFields field

and the request contains an AdditionalFields JSON Object, new key/values will

be appended to the existing $$K_AdditionalFields while existing keys will

have their value overwritten.

When getting the fields from a document, the $$K_AdditionalFields field

should never be returned, instead the client should return a JSON object

named AdditionalFields with the contents of that field, IE: AdditionalFields

{ “Field1” : “First Field”, “Field2” : “Second Field”, “Field3” : “Third Field” } By maintaining the same name throughout, the adding, getting and setting of fields will be consistent and it makes this functionality easier to read and understand.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	AdditionalFieldsName EWS Special -: Additional field names
static java.lang.String	AdditionalFieldsParam EWS SPecial - field parameters

Constructor Summary

Constructors

Constructor and Description
AdditionalFieldsHelper(com.hcl.domino.data.Database db)

Method Summary

Modifier and Type	Method and Description
void	addFields(io.vertx.core.json.JsonObject incomingFields)
io.vertx.core.json.JsonObject	getAdditionalFields()
io.vertx.core.json.JsonObject	getAdditionalFieldsFromDoc(com.hcl.domino.data.Document doc)
void	writeAdditionalFields(com.hcl.domino.data.Document doc)
void	writeAdditionalFields(com.hcl.domino.data.Document doc, io.vertx.core.json.JsonObject incomingAdditionalFields)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

AdditionalFieldsName

public static final java.lang.String AdditionalFieldsName

EWS Special -: Additional field names

See Also:

Constant Field Values

AdditionalFieldsParam

public static final java.lang.String AdditionalFieldsParam

EWS SPecial - field parameters

See Also:

Constant Field Values

Constructor Detail

AdditionalFieldsHelper

public AdditionalFieldsHelper(com.hcl.domino.data.Database db)

Parameters:

db -

Method Detail

addFields

public void addFields(io.vertx.core.json.JsonObject incomingFields)

Parameters:

incomingFields -

getAdditionalFields

public io.vertx.core.json.JsonObject getAdditionalFields()

Returns:

additional fields

getAdditionalFieldsFromDoc

public io.vertx.core.json.JsonObject getAdditionalFieldsFromDoc(com.hcl.domino.data.Document doc)

Parameters:

doc -

Returns:

additional fields

writeAdditionalFields

public void writeAdditionalFields(com.hcl.domino.data.Document doc)

Parameters:

doc - doc to update

writeAdditionalFields

public void writeAdditionalFields(com.hcl.domino.data.Document doc,
                                  io.vertx.core.json.JsonObject incomingAdditionalFields)

Parameters:

doc -

incomingAdditionalFields -