nl.gx.webmanager.cms.core
Interface PersonalizationItem

All Superinterfaces:

Wrapper

All Known Subinterfaces:

PersonalizationExpression, PersonalizationModel

public interface PersonalizationItem
extends Wrapper

This interface defines the common contract of both personalization expressions and models. The personalization expression and model interfaces extends this interface.

Author:

Sander Dahlberg

Method Summary

java.lang.String	getName() Returns the name of the item by which it is identified in the user interface.
PersonalizationCategory	getPersonalizationCategory() Returns the personalization category the item is assigned to.
boolean	isAvailable() Returns true if the item is available, false otherwise.
boolean	isShownByLinks() Returns true if links to the object personalized by the item may still be shown, even though the object itself is hidden by the item.
boolean	isValid() Returns true if the item consists of valid XPATH or XSL, false otherwise.
void	setAvailable(boolean isAvailable) Sets whether the personalization item should be available or not.
void	setName(java.lang.String name) Sets the name of a personalization item.
void	setPersonalizationCategory(PersonalizationCategory category) Sets the personalization category to which the personalization item should belong.
void	setShownByLinks(boolean isShownByLinks) Sets whether the personalization item should show or hide links to the personalized object.

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

getId, getUUID, setId, setUUID

Method Detail

getName

java.lang.String getName()

Returns the name of the item by which it is identified in the user interface.

Returns:

The name of the item by which it is identified in the user interface.

isAvailable

boolean isAvailable()

Returns true if the item is available, false otherwise.

Returns:

true if the item is available, false otherwise.

isShownByLinks

boolean isShownByLinks()

Returns true if links to the object personalized by the item may still be shown, even though the object itself is hidden by the item.

Returns:

true if links to the object personalized by the item may still be shown, even though the object itself is hidden by the item.

isValid

boolean isValid()

Returns true if the item consists of valid XPATH or XSL, false otherwise.

Returns:

true if the item consists of valid XPATH or XSL, false otherwise.

getPersonalizationCategory

PersonalizationCategory getPersonalizationCategory()

Returns the personalization category the item is assigned to. An item does not need to be categorized.

Returns:

Personalization category this item is in. Returns null if the item is not in any category.

setName

void setName(java.lang.String name)

Sets the name of a personalization item.

Parameters:

name - The new name for the personalization item. If null an illegal argument exception is thrown.

setAvailable

void setAvailable(boolean isAvailable)

Sets whether the personalization item should be available or not.

Parameters:

isAvailable - Set to true to make the personalization item available, else false.

setShownByLinks

void setShownByLinks(boolean isShownByLinks)

Sets whether the personalization item should show or hide links to the personalized object.

Parameters:

isShownByLinks - Set to true to make links to the personalized object visible, false to hide them.

setPersonalizationCategory

void setPersonalizationCategory(PersonalizationCategory category)

Sets the personalization category to which the personalization item should belong. An personalization item can only belong to one category, so setting it overwrites any previous category it belonged to.

Parameters:

category - Categorize this item in this category. If category is null then the item is not categorized.