Interface IPlaceholderLibrary

All Superinterfaces:

Serializable

public interface IPlaceholderLibrary
extends Serializable

A list with all placeholders that are available. Placeholders are grouped into groups so that it becomes possible to modify the placeholders of a certain group without affecting placeholders of a different group.

Author:

XIMA MEDIA GmbH

Field Summary

Fields

Modifier and Type	Field	Description
static final IPlaceholderGroup	GROUP_APPOINTMENT
static final IPlaceholderGroup	GROUP_ATTACHMENT
static final IPlaceholderGroup	GROUP_COUNTER
static final IPlaceholderGroup	GROUP_FORM
static final IPlaceholderGroup	GROUP_SYSTEM
static final IPlaceholderGroup	GROUP_TEMPLATE
static final IPlaceholderGroup	GROUP_USER_CURRENT
static final IPlaceholderGroup	GROUP_USER_INITIAL
static final IPlaceholderGroup	GROUP_USER_LAST
static final IPlaceholderGroup	GROUP_USER_PORTAL
static final IPlaceholderGroup	GROUP_USER_PORTAL_ADVANCED
static final IPlaceholderGroup	GROUP_WORKFLOW_ACTION_RESULT
static final IPlaceholderGroup	GROUP_WORKFLOW_TRIGGER_RESULT

Method Summary

Modifier and Type	Method	Description
void	addAll(IPlaceholderGroup group, Iterable<PlaceHolder> placeholders)
void	addAll(Map<IPlaceholderGroup, Set<PlaceHolder>> placeholders)
void	clearAll(IPlaceholderGroup group)
Iterable<org.apache.commons.lang3.tuple.Pair<IPlaceholderGroup, PlaceHolder>>	getAll()
Iterable<PlaceHolder>	getAll(IPlaceholderGroup group)
Iterable<IPlaceholderGroup>	getGroups()
boolean	registerProvider(IPlaceholderProvider listener)
void	remove(IPlaceholderGroup group, PlaceHolder placeholder)
void	removeAll(IPlaceholderGroup group, Iterable<PlaceHolder> placeholders)
void	replaceAll(IPlaceholderGroup group, Iterable<PlaceHolder> placeholders)
boolean	unregisterProvider(IPlaceholderProvider listener)
boolean	updatePlaceholders(IPlaceholderProvideContext updateContext)	Updates all placeholders.

Field Details

GROUP_APPOINTMENT

static final IPlaceholderGroup GROUP_APPOINTMENT

GROUP_ATTACHMENT

static final IPlaceholderGroup GROUP_ATTACHMENT

GROUP_COUNTER

static final IPlaceholderGroup GROUP_COUNTER

GROUP_FORM

static final IPlaceholderGroup GROUP_FORM

GROUP_SYSTEM

static final IPlaceholderGroup GROUP_SYSTEM

GROUP_TEMPLATE

static final IPlaceholderGroup GROUP_TEMPLATE

GROUP_USER_CURRENT

static final IPlaceholderGroup GROUP_USER_CURRENT

GROUP_USER_INITIAL

static final IPlaceholderGroup GROUP_USER_INITIAL

GROUP_USER_LAST

static final IPlaceholderGroup GROUP_USER_LAST

GROUP_USER_PORTAL

static final IPlaceholderGroup GROUP_USER_PORTAL

GROUP_USER_PORTAL_ADVANCED

static final IPlaceholderGroup GROUP_USER_PORTAL_ADVANCED

GROUP_WORKFLOW_ACTION_RESULT

static final IPlaceholderGroup GROUP_WORKFLOW_ACTION_RESULT

GROUP_WORKFLOW_TRIGGER_RESULT

static final IPlaceholderGroup GROUP_WORKFLOW_TRIGGER_RESULT

Method Details

addAll

void addAll(IPlaceholderGroup group,
 Iterable<PlaceHolder> placeholders)

addAll

void addAll(Map<IPlaceholderGroup, Set<PlaceHolder>> placeholders)

clearAll

void clearAll(IPlaceholderGroup group)

getAll

Iterable<org.apache.commons.lang3.tuple.Pair<IPlaceholderGroup, PlaceHolder>> getAll()

getAll

Iterable<PlaceHolder> getAll(IPlaceholderGroup group)

getGroups

Iterable<IPlaceholderGroup> getGroups()

remove

void remove(IPlaceholderGroup group,
 PlaceHolder placeholder)

removeAll

void removeAll(IPlaceholderGroup group,
 Iterable<PlaceHolder> placeholders)

replaceAll

void replaceAll(IPlaceholderGroup group,
 Iterable<PlaceHolder> placeholders)

registerProvider

boolean registerProvider(IPlaceholderProvider listener)

unregisterProvider

boolean unregisterProvider(IPlaceholderProvider listener)

updatePlaceholders

boolean updatePlaceholders(IPlaceholderProvideContext updateContext)

Updates all placeholders.

Parameters:

updateContext - the context for updating the placeholders

Returns:

true if there an asynchronous update was triggered, false otherwise