nl.gx.webmanager.services.contentapi
Interface PersonalizationManagementService

public interface PersonalizationManagementService

This interface defines the personalization management service for offering create and delete methods for personalization expressions, models and categories.

Author:

Sander Dahlberg

Method Summary

PersonalizationCategory	createPersonalizationCategory(Website website, java.lang.String categoryName, java.lang.String value) Creates a personalization category with the given name and value.
PersonalizationExpression	createPersonalizationExpression(Website website) Creates a personalization expression for the given website.
PersonalizationModel	createPersonalizationModel(Website website) Creates a personalization model for the given website.
void	deletePersonalizationCategory(PersonalizationCategory category) Permanently deletes a personalization category.
void	deletePersonalizationExpression(PersonalizationExpression expression) Permanently deletes a personalization expression.
void	deletePersonalizationModel(PersonalizationModel model) Permanently deletes a personalization model.
PersonalizationExpression	getPersonalizationExpression(java.lang.String idString) Gets a personalization expression instance from the given identifier string.
PersonalizationModel	getPersonalizationModel(java.lang.String idString) Gets a personalization expression instance from the given identifier string.

Method Detail

getPersonalizationExpression

PersonalizationExpression getPersonalizationExpression(java.lang.String idString)

Gets a personalization expression instance from the given identifier string. This string is to be obtained by calling PersonalizationExpression#getId()#toString() on a PersonalizationExpression instance which has been created by a PersonalizationManagementService instance.

Parameters:

idString - The id string to use to create a PersonalizationExpression instance.

Returns:

A PersonalizationExpression instance.

getPersonalizationModel

PersonalizationModel getPersonalizationModel(java.lang.String idString)

Gets a personalization expression instance from the given identifier string. This string is to be obtained by calling PersonalizationExpression#getId()#toString() on a PersonalizationExpression instance which has been created by a PersonalizationManagementService instance.

Parameters:

idString - The id string to use to create a PersonalizationExpression instance.

Returns:

A PersonalizationExpression instance.

createPersonalizationExpression

PersonalizationExpression createPersonalizationExpression(Website website)

Creates a personalization expression for the given website.

Default settings are:

• Name: ""
• Available: false
• Type: PersonalizationExpression.Type#CONDITION
• Shown by links: false
• Value: ""
• Tag name: ""

Parameters:

website - Target website.

Returns:

New personalization expression.

createPersonalizationModel

PersonalizationModel createPersonalizationModel(Website website)

Creates a personalization model for the given website.

Default settings are:

• Name: ""
• Available: false
• Operator: PersonalizationModel.Operator#AND
• Shown by links: false
• Using not operator: false

Parameters:

website - Target website.

Returns:

New personalization model.

createPersonalizationCategory

PersonalizationCategory createPersonalizationCategory(Website website,
                                                      java.lang.String categoryName,
                                                      java.lang.String value)

Creates a personalization category with the given name and value. The personalization category is available only for the given website. A personalization category is used for categorizing personalization expressions and models.

Parameters:

website - Website to create the personalization category for.

categoryName - Name of the category.

value - Value of the category. Can be used as a parameter to retrieve a specific personalization category through Website.getPersonalizationCategory(String). Make sure a unique value is chosen over all category values, within the scope of the given website. There is no uniqueness validation.

Returns:

Newly created personalization category.

deletePersonalizationExpression

void deletePersonalizationExpression(PersonalizationExpression expression)

Permanently deletes a personalization expression.

Parameters:

expression - Personalization expression to delete.

deletePersonalizationModel

void deletePersonalizationModel(PersonalizationModel model)

Permanently deletes a personalization model.

Parameters:

model - Personalization model to delete.

deletePersonalizationCategory

void deletePersonalizationCategory(PersonalizationCategory category)

Permanently deletes a personalization category. It is permitted to delete a category that currently holds personalization expressions and/or models. Those expressions and models are not deleted, but are not categorized afterwards.

Parameters:

category - Personalization category to delete.