nl.gx.webmanager.cms.core
Interface PersonalizationModel

All Superinterfaces:

PersonalizationItem, Wrapper

public interface PersonalizationModel
extends PersonalizationItem

Expression, composed by a number of PersonalizationExpression objects, which can be applied to the session xml on the frontend.

Author:

arjans

Nested Class Summary

static class

PersonalizationModel.Operator Operator used to concatenate contained PersonalizationExpression and/or PersonalizationModel objects with.

Method Summary

PersonalizationExpression[]	getExpressions() Returns an array containing all PersonalizationExpression objects contained by this PersonalizationModel.
PersonalizationModel[]	getModels() Returns an array containing all PersonalizationModel objects contained by this PersonalizationModel.
PersonalizationModel.Operator	getOperator() Returns the Operator used by this PersonalizationModel to links its PersonalizationExpression objects by.
PersonalizationItem[]	getPersonalizationItems() Returns all personalization items that are contained by this personalization model.
boolean	isUsingNotOperator() Returns true if the not operator should be applied to the result of the PersonalizationModel.
void	setOperator(PersonalizationModel.Operator operator) Sets the logical operator for the personalization model.
void	setPersonalizationItems(PersonalizationItem[] personalizationItems) Sets the personalization items for the personalization model.
void	setUsingNotOperator(boolean isUsingNotOperator) Sets the logical negation flag for the personalization model.

Methods inherited from interface nl.gx.webmanager.cms.core.PersonalizationItem

getName, getPersonalizationCategory, isAvailable, isShownByLinks, isValid, setAvailable, setName, setPersonalizationCategory, setShownByLinks

Methods inherited from interface nl.gx.webmanager.wrapper.Wrapper

getId, getUUID, setId, setUUID

Method Detail

getOperator

PersonalizationModel.Operator getOperator()

Returns the Operator used by this PersonalizationModel to links its PersonalizationExpression objects by.

Returns:

The Operator used by this PersonalizationModel to links its PersonalizationExpression objects by.

isUsingNotOperator

boolean isUsingNotOperator()

Returns true if the not operator should be applied to the result of the PersonalizationModel.

Returns:

True if the not operator should be applied to the result of the PersonalizationModel.

getExpressions

PersonalizationExpression[] getExpressions()

Returns an array containing all PersonalizationExpression objects contained by this PersonalizationModel.

Returns:

An array containing all PersonalizationExpression objects contained by this PersonalizationModel.

getModels

PersonalizationModel[] getModels()

Returns an array containing all PersonalizationModel objects contained by this PersonalizationModel.

Returns:

An array containing all PersonalizationModel objects contained by this PersonalizationModel.

getPersonalizationItems

PersonalizationItem[] getPersonalizationItems()

Returns all personalization items that are contained by this personalization model. Personalization items consists of all personalization expressions and models.

Returns:

All personalization items.

setOperator

void setOperator(PersonalizationModel.Operator operator)

Sets the logical operator for the personalization model. Used to join all the assigned personalization items in one big XPATH expression.

Parameters:

operator - The new operator for this personalization model.

setUsingNotOperator

void setUsingNotOperator(boolean isUsingNotOperator)

Sets the logical negation flag for the personalization model. Used to flip the boolean result of executing the combined XPATH expression.

Parameters:

isUsingNotOperator - Set to true to flip the result of executing the combined XPATH expression.

setPersonalizationItems

void setPersonalizationItems(PersonalizationItem[] personalizationItems)

Sets the personalization items for the personalization model. Both expressions and models can be assigned. Only expressions of type PersonalizationExpression.Type.CHOOSE and PersonalizationExpression.Type.CONDITION are allowed.

Parameters:

personalizationItems - All these personalization items are assigned. Any previous items are unassigned.