com.hcl.domino.keep.dbrequests.pim

Class LabelHelper

java.lang.Object

com.hcl.domino.keep.dbrequests.pim.LabelHelper

public class LabelHelper
extends java.lang.Object

Utility class to translate ACL Entries to delegation status back and forth

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LabelHelper.LabelInclusion flag to get all or mail labels

Constructor Summary

Constructors

Constructor and Description
LabelHelper() Standard constructor

Method Summary

Modifier and Type	Method and Description
protected void	buildLabelList(DbRequestParameters<io.vertx.core.json.JsonObject> request, KeepFactory keepFactory, KeepDbInfo keepDbInfo) Collect label details
protected java.lang.String	filterDesignType(java.lang.String type) Get the folder design base on type of documents that will be stored
protected java.lang.String	filterFolderName(com.hcl.domino.data.Database db, java.lang.String designType, java.lang.String parentName, java.lang.String folderName) Filter the name of the folder/label that will be created
io.vertx.core.json.JsonObject	getAllCollections()
protected long	getChildFolderCount(io.vertx.core.json.JsonObject folderCollectionResult, java.lang.String unid)
java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.String>>	getChildIDs(java.lang.String incomingunid, boolean includeParentInResults)
java.util.function.Predicate<com.hcl.domino.data.DominoCollectionInfo>	getCollectionFilter(java.util.Map<java.lang.String,java.lang.String> systemFolderNames, java.util.Map<java.lang.String,java.lang.String> systemLabels, boolean includeSystemLabels)
LabelHelper.LabelInclusion	getLabelInclusion()
protected static java.lang.String	getParentFolderName(java.lang.String currentFolderName) Filter current folder to get the parent folder
boolean	includeInOutput(java.util.Map<java.lang.String,java.lang.String> systemLabels, com.hcl.domino.data.DominoCollectionInfo ncs, boolean includeSystemLabels) filter if system labels should be included in the result
java.util.Map<java.lang.String,java.lang.String>	populateSystemFolders(io.vertx.core.json.JsonObject pimConfig)
java.util.Map<java.lang.String,java.lang.String>	populateSystemLabels() populate system labels
void	setCollectionFilter(java.util.function.Predicate<com.hcl.domino.data.DominoCollectionInfo> collectionFilter)
void	setLabelInclusion(LabelHelper.LabelInclusion labelInclusion) Set the flag for inclusion

Methods inherited from class java.lang.Object

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

Constructor Detail

LabelHelper

public LabelHelper()

Standard constructor

Method Detail

getParentFolderName

protected static java.lang.String getParentFolderName(java.lang.String currentFolderName)

Filter current folder to get the parent folder

Parameters:

currentFolderName -

Returns:

parent folder name

getAllCollections

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

Returns:

return all folders based on incoming incoming

getChildIDs

public java.util.Map<java.lang.String,java.util.Map<java.lang.String,java.lang.String>> getChildIDs(java.lang.String incomingunid,
                                                                                                    boolean includeParentInResults)

Parameters:

incomingunid -

• unid of folder you want all of it’s children

includeParentInResults -

• results contain the incoming unid

Returns:

Map of the the children and some properties of that folder document.

getCollectionFilter

public java.util.function.Predicate<com.hcl.domino.data.DominoCollectionInfo> getCollectionFilter(java.util.Map<java.lang.String,java.lang.String> systemFolderNames,
                                                                                                  java.util.Map<java.lang.String,java.lang.String> systemLabels,
                                                                                                  boolean includeSystemLabels)

Parameters:

systemFolderNames -

systemLabels -

Returns:

filtered collected folders

getLabelInclusion

public LabelHelper.LabelInclusion getLabelInclusion()

Returns:

get flag for inclusion

includeInOutput

public boolean includeInOutput(java.util.Map<java.lang.String,java.lang.String> systemLabels,
                               com.hcl.domino.data.DominoCollectionInfo ncs,
                               boolean includeSystemLabels)

filter if system labels should be included in the result

Parameters:

systemLabels -

ncs -

includeSystemLabels -

Returns:

• validated of system labels

populateSystemFolders

public java.util.Map<java.lang.String,java.lang.String> populateSystemFolders(io.vertx.core.json.JsonObject pimConfig)

Parameters:

pimConfig -

• JsonObject

Returns:

Map for lookup

populateSystemLabels

public java.util.Map<java.lang.String,java.lang.String> populateSystemLabels()

populate system labels

Returns:

System Labels

setCollectionFilter

public void setCollectionFilter(java.util.function.Predicate<com.hcl.domino.data.DominoCollectionInfo> collectionFilter)

Parameters:

collectionFilter -

setLabelInclusion

public void setLabelInclusion(LabelHelper.LabelInclusion labelInclusion)

Set the flag for inclusion

Parameters:

labelInclusion -

buildLabelList

protected void buildLabelList(DbRequestParameters<io.vertx.core.json.JsonObject> request,
                              KeepFactory keepFactory,
                              KeepDbInfo keepDbInfo)

Collect label details

Parameters:

request -

keepFactory -

keepDbInfo -

filterDesignType

protected java.lang.String filterDesignType(java.lang.String type)

Get the folder design base on type of documents that will be stored

Parameters:

type -

Returns:

new folder/label base design

filterFolderName

protected java.lang.String filterFolderName(com.hcl.domino.data.Database db,
                                            java.lang.String designType,
                                            java.lang.String parentName,
                                            java.lang.String folderName)

Filter the name of the folder/label that will be created

Parameters:

db -

designType -

parentName -

folderName -

Returns:

complete view name

getChildFolderCount

protected long getChildFolderCount(io.vertx.core.json.JsonObject folderCollectionResult,
                                   java.lang.String unid)

Parameters:

folderCollectionResult -

unid -

Returns:

child folder count