com.hcl.domino.keep.dbrequests.pim

Class AddRemoveToLabel

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.AddRemoveToLabel

All Implemented Interfaces:

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

@MinimumAcl(value=DEPOSITOR)
 @AclAttributes(value=CreatePersonalFoldersViews)
public class AddRemoveToLabel
extends AsyncDominoJNXJson

Implements OperationId: addRemoveToLabel Add, Remove or Move document/s to label/folder Example incoming: { "labelid": "B3E63E5F418514CF48258581003828B0", "body": { "add": [ "72272B27A1139F114825859E003C6B70" ], "remove": [ "15AA9D4CE38C52074825859E003D3338" ], "move": [ "C55358B43FF627A4482585680064382F" ] }, "headers": { "jwtclaim": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9 .eyJpc3MiOiJUaGUgRGVtbyBXaXp6YXJkIiwic3ViIjoiTWFudWVsIExvcmVuem8gTGVybWEvUGhpbGlwcGluZXM vUE5QSENMIiwiaWF0IjoxNTk2NjMwNDAxLCJleHAiOjE1OTY2NTIwMDEsImF1ZCI6IkRvbWlubyJ9 .-6WvBv1_diwteHbChRKkERJQ6iK8F_Q6ALu5Fw6bn5Y", "db": "MAIL", "operationId": "addRemoveToLabel", "mergeChunks": "false", "sourceForEventBus": "com.hcl.domino.keep.handlers.pim.DefaultPimHandler", "tags": "mail" }, "replicaid": "482585590040A750", "apiName": "MAIL", "filepath": "DemoMail.nsf", "title": "DemoMail" } Example result: { "Add Status": "Successful addition of 1 documents to label B3E63E5F418514CF48258581003828B0", "addedIds": [ { "status": "OK", "statusCode": 200, "message": "Add successful", "unid": "72272B27A1139F114825859E003C6B70" } } ], "Remove Status": "Successful removal of 1 documents to label B3E63E5F418514CF48258581003828B0", "removedIds": [ { "status": "OK", "statusCode": 200, "message": "remove successful", "unid": "15AA9D4CE38C52074825859E003D3338" } ] }

Nested Class Summary

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

AsyncDominoBase.RequestType

Field Summary

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

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

Constructor Summary

Constructors

Constructor and Description
AddRemoveToLabel()

Method Summary

Modifier and Type	Method and Description
com.hcl.domino.misc.Pair<java.lang.String,java.lang.String>	displayMessage(java.lang.String status, int count, java.lang.String labelId)
void	process(DbRequestParameters<io.vertx.core.json.JsonObject> request) Returns details of add, move or remove documents to label

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

Constructor Detail

AddRemoveToLabel

public AddRemoveToLabel()

Method Detail

displayMessage

public com.hcl.domino.misc.Pair<java.lang.String,java.lang.String> displayMessage(java.lang.String status,
                                                                                  int count,
                                                                                  java.lang.String labelId)

Parameters:

status -

count -

labelId -

Returns:

a Pair for display

process

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

Returns details of add, move or remove documents to label

Parameters:

request - DbRequestParameters granting access to session and database

Throws:

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