com.hcl.domino.keep.dbrequests.pim

Class UpdateMessageProperties

java.lang.Object

com.hcl.domino.keep.dbrequests.AsyncDominoJNX<io.vertx.core.json.JsonObject>

com.hcl.domino.keep.dbrequests.AsyncDominoJNXJson

com.hcl.domino.keep.dbrequests.pim.UpdateMessageProperties

All Implemented Interfaces:

AsyncDominoBase<io.vertx.core.json.JsonObject>, KeepSubscriberInfo, io.reactivex.ObservableOnSubscribe<io.vertx.core.json.JsonObject>

public class UpdateMessageProperties
extends AsyncDominoJNXJson

UpdateMessageProperties iterates over lists of messages and sets / unsets three properties flags: follow up, soft delete, and unread.

Nested Class Summary

Nested classes/interfaces inherited from interface com.hcl.domino.keep.dbrequests.AsyncDominoBase

AsyncDominoBase.RequestType

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	contentFound
protected io.vertx.core.json.JsonObject	result

Fields inherited from class com.hcl.domino.keep.dbrequests.AsyncDominoJNX

apiName, appTags, logger, requestParams, UNNEEDED_CALL, user, vertx

Constructor Summary

Constructors

Constructor and Description
UpdateMessageProperties()

Method Summary

Modifier and Type	Method and Description
static java.util.List<java.lang.String>	convertToArray(io.vertx.core.json.JsonArray jsonIdArray) convertToArray converts a JsonArray of Document unids to an ArrayList.
protected void	handleFollowUpFlag(KeepJnxSession s, com.hcl.domino.data.Database db, io.vertx.core.json.JsonArray followUpOnIds, io.vertx.core.json.JsonArray followUpOffIds) handleFollowUpFlag turns a document’s Follow Up flag on or off.
protected void	handleFollowUpFlagImpl(KeepJnxSession s, com.hcl.domino.data.Database db, io.vertx.core.json.JsonArray docIds, boolean followUp) handleFollowUpFlagImpl turns a document’s Follow Up flag on or off.
protected void	handleSoftDeleteFlag(KeepJnxSession s, com.hcl.domino.data.Database db, io.vertx.core.json.JsonArray softDeleteOnIds, io.vertx.core.json.JsonArray softDeleteOffIds) handleSoftDeleteFlag turns a document’s Soft Delete flag on or off.
protected void	handleSoftDeleteFlagImpl(KeepJnxSession s, com.hcl.domino.data.Database db, io.vertx.core.json.JsonArray docIds, boolean softDelete) handleSoftDeleteFlagImpl turns a document’s Soft Delete flag on or off.
protected void	handleUnreadFlag(com.hcl.domino.DominoClient client, KeepJnxSession s, com.hcl.domino.data.Database db, io.vertx.core.json.JsonArray unreadOnIds, io.vertx.core.json.JsonArray unreadOffIds) handleUnreadFlag turns a document’s Unread flag on or off.
protected void	onAbsenceOfEitherFollowupIds(DbRequestParameters<io.vertx.core.json.JsonObject> request, io.vertx.core.json.JsonArray followUpOnIds, io.vertx.core.json.JsonArray followUpOffIds)
void	process(DbRequestParameters<io.vertx.core.json.JsonObject> request) process fetches lists of document ids.

Methods inherited from class com.hcl.domino.keep.dbrequests.AsyncDominoJNXJson

getDbRequestParameters

Methods inherited from class com.hcl.domino.keep.dbrequests.AsyncDominoJNX

accessControlCheck, dontCallProcessPayload, emitterToObserver, getActualDatabaseName, getApiName, getAppTags, getBarbican, getEventbusId, getKeepDbInfo, getRequestType, getSubscriber, getUser, getUserForMetrics, isProcessPayloadRequired, isWorkInProgress, processDominoRequest, recordAppMetrics, setApiName, setBarbican, setDbFileName, setKeepDbInfo, setProcessPayloadRequired, setRequestParams, setRequestType, setSubscriber, setUser, setVertx, subscribe, validateDqlAccess, validateOpenAccess, validationCheck

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.hcl.domino.keep.dbrequests.AsyncDominoBase

customValidator, preflight

Field Detail

contentFound

protected boolean contentFound

result

protected final io.vertx.core.json.JsonObject result

Constructor Detail

UpdateMessageProperties

public UpdateMessageProperties()

Method Detail

convertToArray

public static java.util.List<java.lang.String> convertToArray(io.vertx.core.json.JsonArray jsonIdArray)

convertToArray converts a JsonArray of Document unids to an ArrayList.

Parameters:

jsonIdArray - the array to convert

handleFollowUpFlag

protected void handleFollowUpFlag(KeepJnxSession s,
                                  com.hcl.domino.data.Database db,
                                  io.vertx.core.json.JsonArray followUpOnIds,
                                  io.vertx.core.json.JsonArray followUpOffIds)

handleFollowUpFlag turns a document’s Follow Up flag on or off.

Parameters:

s - current session

db - current database

followUpOnIds - documents to turn on Follow Up

followUpOffIds - documents to turn off Follow Up

handleFollowUpFlagImpl

protected void handleFollowUpFlagImpl(KeepJnxSession s,
                                      com.hcl.domino.data.Database db,
                                      io.vertx.core.json.JsonArray docIds,
                                      boolean followUp)

handleFollowUpFlagImpl turns a document’s Follow Up flag on or off.

Parameters:

s - current session

db - current database

docIds - the array of document ids to be processed

followUp - true if soft delete should be turned on

handleSoftDeleteFlag

protected void handleSoftDeleteFlag(KeepJnxSession s,
                                    com.hcl.domino.data.Database db,
                                    io.vertx.core.json.JsonArray softDeleteOnIds,
                                    io.vertx.core.json.JsonArray softDeleteOffIds)

handleSoftDeleteFlag turns a document’s Soft Delete flag on or off.

Parameters:

s - current session

db - current database

softDeleteOnIds - documents to turn on Soft Delete

softDeleteOffIds - documents to turn off Soft Delete

handleSoftDeleteFlagImpl

protected void handleSoftDeleteFlagImpl(KeepJnxSession s,
                                        com.hcl.domino.data.Database db,
                                        io.vertx.core.json.JsonArray docIds,
                                        boolean softDelete)

handleSoftDeleteFlagImpl turns a document’s Soft Delete flag on or off.

Parameters:

s - current session

db - current database

docIds - the array of document ids to be processed

softDelete - true if soft delete should be turned on

handleUnreadFlag

protected void handleUnreadFlag(com.hcl.domino.DominoClient client,
                                KeepJnxSession s,
                                com.hcl.domino.data.Database db,
                                io.vertx.core.json.JsonArray unreadOnIds,
                                io.vertx.core.json.JsonArray unreadOffIds)

handleUnreadFlag turns a document’s Unread flag on or off.

Parameters:

s - current session

db - current database

unreadOnIds - documents to be marked unread

unreadOffIds - documents to be marked read

onAbsenceOfEitherFollowupIds

protected void onAbsenceOfEitherFollowupIds(DbRequestParameters<io.vertx.core.json.JsonObject> request,
                                            io.vertx.core.json.JsonArray followUpOnIds,
                                            io.vertx.core.json.JsonArray followUpOffIds)

Parameters:

request -

followUpOnIds -

followUpOffIds -

process

public void process(DbRequestParameters<io.vertx.core.json.JsonObject> request)
             throws java.lang.Exception

process fetches lists of document ids. Tt then iterates over each list, fetches the proper document, and changes its corresponding message property.

followUpOn document ids to turn on Follow Up followUpOFF documents ids to turn off Follow Up softDeleteOn documents ids to turn on Soft DeleteOn softDeleteOff documents to turn off Soft Delete

Parameters:

request -

Throws:

java.lang.Exception - Anything that can go wrong, will go wrong