org.jahia.services.preferences

Interface JahiaPreferencesProvider<T extends JCRNodeWrapper>

All Known Implementing Classes:

JahiaPreferencesJCRProviders

public interface JahiaPreferencesProvider<T extends JCRNodeWrapper>

User: jahia Date: 19 mars 2008 Time: 11:44:07

Method Summary

Modifier and Type	Method and Description
JahiaPreference<T>	createJahiaPreferenceNode(Principal principal) Create a JahiaPeference with "empty" properties
void	deleteAllPreferencesByPrincipal(Principal principal) Delete all preferences of principal.
void	deleteJahiaPreference(JahiaPreference<T> jahiaPreference) Delete Jahia Prefernce
void	deleteJahiaPreference(Principal principal, String sqlConstraint) Delete Jahia Preference
List<JahiaPreference<T>>	findJahiaPreferences(Principal principal, String sqlConstraint) Find all preferences for a user mathing certain sqlConstraint
List<JahiaPreference<T>>	getJahiaAllPreferences(Principal principal) Get all preferences of a user.
JahiaPreference<T>	getJahiaPreference(Principal principal, String sqlConstraint) Get the existing JahiaPreference associated to this path
JahiaPreference<T>	getJahiaPreference(Principal principal, String sqlConstraint, boolean notNull) Get or create the requested preference at the path
String	getType() Get the type of the provider.
void	setJahiaPreference(JahiaPreference<T> jahiaPreference) Set Jahia preference
void	setJahiaPreferenceByMaps(Map<String,String> jahiaPreferenceAttributes) Set a jahia preference value.
boolean	validate(JahiaPreference<T> jahiaPreference)

Method Detail

getType

String getType()

Get the type of the provider. Each provider has a unique type.

Returns:

createJahiaPreferenceNode

JahiaPreference<T> createJahiaPreferenceNode(Principal principal)

Create a JahiaPeference with "empty" properties

Parameters:

principal -

Returns:

validate

boolean validate(JahiaPreference<T> jahiaPreference)
          throws JahiaPreferencesNotValidException

Parameters:

jahiaPreference -

Returns:

true if the preference value is correct

Throws:

JahiaPreferencesNotValidException

getJahiaPreference

JahiaPreference<T> getJahiaPreference(Principal principal,
                                      String sqlConstraint)

Get the existing JahiaPreference associated to this path

Parameters:

principal - the user for searching the preference

sqlConstraint - the sql constraint of the preference

Returns:

a JahiaPreference if found null otherwise

getJahiaPreference

JahiaPreference<T> getJahiaPreference(Principal principal,
                                      String sqlConstraint,
                                      boolean notNull)

Get or create the requested preference at the path

Parameters:

principal - the user for searching the preference

sqlConstraint - the sql constraint of the preference

notNull - if true create the preference if not found

Returns:

a JahiaPreference if prefrence found or notNull is true, null otherwise

getJahiaAllPreferences

List<JahiaPreference<T>> getJahiaAllPreferences(Principal principal)

Get all preferences of a user. WARNING: if there is lots of preferences, it can be time consuming.

Parameters:

principal - the user for whom we want the prefrences

Returns:

a List of all JahiaPreference for this user

findJahiaPreferences

List<JahiaPreference<T>> findJahiaPreferences(Principal principal,
                                              String sqlConstraint)

Find all preferences for a user mathing certain sqlConstraint

Parameters:

principal - the user for whom we want the prefrences

sqlConstraint - the sql constraint of the preference

Returns:

a List of all JahiaPreference for this user

deleteJahiaPreference

void deleteJahiaPreference(Principal principal,
                           String sqlConstraint)
                    throws JahiaPreferenceNotDefinedAttributeException

Delete Jahia Preference

Parameters:

principal - the user for whom we want the prefrences

sqlConstraint - the sql constraint of the preference

Throws:

JahiaPreferenceNotDefinedAttributeException

deleteJahiaPreference

void deleteJahiaPreference(JahiaPreference<T> jahiaPreference)

Delete Jahia Prefernce

Parameters:

jahiaPreference - the preference to delete

setJahiaPreference

void setJahiaPreference(JahiaPreference<T> jahiaPreference)

Set Jahia preference

Parameters:

jahiaPreference - the preference to set

setJahiaPreferenceByMaps

void setJahiaPreferenceByMaps(Map<String,String> jahiaPreferenceAttributes)
                       throws JahiaPreferenceNotDefinedAttributeException,
                              JahiaPreferenceNotDefinedPropertyException,
                              JahiaPreferencesNotValidException

Set a jahia preference value. The jahia preference key object is created dynamically from the corresponding map.

Parameters:

jahiaPreferenceAttributes -

Throws:

JahiaPreferenceNotDefinedAttributeException

JahiaPreferenceNotDefinedPropertyException

JahiaPreferencesNotValidException

deleteAllPreferencesByPrincipal

void deleteAllPreferencesByPrincipal(Principal principal)

Delete all preferences of principal. All others attributes of the jahia preference key are ignored.

Parameters:

principal -