com.sssw.fw.usermgr.api
Interface EbiPersonalizeManager

public interface EbiPersonalizeManager

This provides an interface for the user personalize manager.

Method Summary

boolean	addGroupPreference(EbiContext ctx, EbiGroupPreferenceInfo userpref) Adds a group preference info.
boolean	addUserPreference(EbiContext ctx, EbiUserPreferenceInfo userpref) Adds user preference info of a component for a specified user.
EbiGroupPreferenceInfo	getGroupPreference(EbiContext ctx, String elementType, String elementID) Gets group preference info of a specified element.
EbiGroupPreferenceInfo[]	getGroupPreferences(EbiContext ctx, String elementType) Gets group preference info list for a specified element type.
EbiUserPreferenceInfo	getUserPreference(EbiContext ctx, String userIID, String elementType, String elementID) Gets user preference info for a specified user and specified element.
EbiUserPreferenceInfo[]	getUserPreferences(EbiContext ctx, String userIID) Gets user preference info objects for a user.
EbiUserPreferenceInfo[]	getUserPreferences(EbiContext ctx, String userIID, String elementType) Gets user preference info objects related to a particular element type for a user.
boolean	modifyGroupPreference(EbiContext ctx, EbiGroupPreferenceInfo groupPref) Modifies a group preference info of a specified element.
boolean	modifyUserPreference(EbiContext ctx, EbiUserPreferenceInfo userpref) Modifies user preference info of a component for a specified user.
boolean	removeGroupPreference(EbiContext ctx, String elementType, String elementID) Removes a group preference info.
boolean	removeGroupPreferences(EbiContext ctx, String elementType) Removes all group preference info objects that are associated with the specified element type.
boolean	removeUserPreference(EbiContext ctx, String userIID, String elementType, String elementID) Removes user preference info of a component for a specified user.
boolean	removeUserPreferences(EbiContext ctx, String userIID) Removes all user preference data for a specified user.
boolean	removeUserPreferences(EbiContext ctx, String userIID, String elementType) Removes user preference info of all components for a specified user.

Method Detail

getUserPreference

public EbiUserPreferenceInfo getUserPreference(EbiContext ctx,
                                               String userIID,
                                               String elementType,
                                               String elementID)
                                        throws EboUnrecoverableSystemException,
                                               EboSecurityException

Gets user preference info for a specified user and specified element.

Parameters:

ctx - an EbiContext object.

userIID - a user UUID.

elementType - a type of element

elementID - a elemtn id

Returns:

an EbiUserPreferenceInfo object for the specified user and specified element.

getUserPreferences

public EbiUserPreferenceInfo[] getUserPreferences(EbiContext ctx,
                                                  String userIID)
                                           throws EboUnrecoverableSystemException,
                                                  EboSecurityException

Gets user preference info objects for a user.

Parameters:

ctx - an EbiContext object.

userIID - a user UUID.

Returns:

an array of EbiUserPreference objects for the specified user.

getUserPreferences

public EbiUserPreferenceInfo[] getUserPreferences(EbiContext ctx,
                                                  String userIID,
                                                  String elementType)
                                           throws EboUnrecoverableSystemException,
                                                  EboSecurityException

Gets user preference info objects related to a particular element type for a user.

Parameters:

ctx - an EbiContext object.

userIID - a user UUID.

elementType - an element Type.

Returns:

an array of EbiUserPreference objects for the specified element type and user.

addUserPreference

public boolean addUserPreference(EbiContext ctx,
                                 EbiUserPreferenceInfo userpref)
                          throws EboUnrecoverableSystemException,
                                 EboSecurityException

Adds user preference info of a component for a specified user.

Parameters:

ctx - an EbiContext object.

userpref - an EbiUserPreference object.

Returns:

true if the specified user preference is added successfully, false otherwise.

modifyUserPreference

public boolean modifyUserPreference(EbiContext ctx,
                                    EbiUserPreferenceInfo userpref)
                             throws EboUnrecoverableSystemException,
                                    EboSecurityException

Modifies user preference info of a component for a specified user.

Parameters:

ctx - an EbiContext object.

userpref - an EbiUserPreference object.

Returns:

true if the specified user preference is modified successfully, false otherwise.

removeUserPreference

public boolean removeUserPreference(EbiContext ctx,
                                    String userIID,
                                    String elementType,
                                    String elementID)
                             throws EboUnrecoverableSystemException,
                                    EboSecurityException

Removes user preference info of a component for a specified user.

Parameters:

ctx - an EbiContext object.

userIID - a user UUID.

elementType - element type. (cannot be null)

elementID - element type. (cannot be null)

Returns:

true if the specified user preference is removed successfully, false otherwise.

removeUserPreferences

public boolean removeUserPreferences(EbiContext ctx,
                                     String userIID,
                                     String elementType)
                              throws EboUnrecoverableSystemException,
                                     EboSecurityException

Removes user preference info of all components for a specified user.

Parameters:

ctx - an EbiContext object.

userIID - a user UUID.

elementType - an element type. (cannot be null)

Returns:

true if the specified user preferences are removed successfully, false otherwise.

removeUserPreferences

public boolean removeUserPreferences(EbiContext ctx,
                                     String userIID)
                              throws EboUnrecoverableSystemException,
                                     EboSecurityException

Removes all user preference data for a specified user.

Parameters:

ctx - an EbiContext object.

userIID - a user UUID.

Returns:

true if the specified user preferences are removed successfully, false otherwise.

getGroupPreference

public EbiGroupPreferenceInfo getGroupPreference(EbiContext ctx,
                                                 String elementType,
                                                 String elementID)
                                          throws EboUnrecoverableSystemException,
                                                 EboSecurityException

Gets group preference info of a specified element.

Parameters:

ctx - an EbiContext object.

elementType - a type of element

elementID - a elemtn id

Returns:

an EbiGroupPreferenceInfo object for the specified element.

getGroupPreferences

public EbiGroupPreferenceInfo[] getGroupPreferences(EbiContext ctx,
                                                    String elementType)
                                             throws EboUnrecoverableSystemException,
                                                    EboSecurityException

Gets group preference info list for a specified element type.

Parameters:

ctx - an EbiContext object.

elementType - an element type.

Returns:

an array of all EbiUserPreference objects.

addGroupPreference

public boolean addGroupPreference(EbiContext ctx,
                                  EbiGroupPreferenceInfo userpref)
                           throws EboUnrecoverableSystemException,
                                  EboSecurityException

Adds a group preference info.

Parameters:

ctx - an EbiContext object.

groupPref - an EbiGroupPreference object.

Returns:

true if the specified group preference is added successfully, false otherwise.

modifyGroupPreference

public boolean modifyGroupPreference(EbiContext ctx,
                                     EbiGroupPreferenceInfo groupPref)
                              throws EboUnrecoverableSystemException,
                                     EboSecurityException

Modifies a group preference info of a specified element.

Parameters:

ctx - an EbiContext object.

groupPref - an EbiGroupPreference object.

Returns:

true if the specified group preference is modified successfully, false otherwise.

removeGroupPreference

public boolean removeGroupPreference(EbiContext ctx,
                                     String elementType,
                                     String elementID)
                              throws EboUnrecoverableSystemException,
                                     EboSecurityException

Removes a group preference info.

Parameters:

ctx - an EbiContext object.

elementType - element type. (cannot be null)

elementID - element type. (cannot be null)

Returns:

true if the specified group preference is removed successfully, false otherwise.

removeGroupPreferences

public boolean removeGroupPreferences(EbiContext ctx,
                                      String elementType)
                               throws EboUnrecoverableSystemException,
                                      EboSecurityException

Removes all group preference info objects that are associated with the specified element type.

Parameters:

ctx - an EbiContext object.

elementType - an element type.

Returns:

true if all group preference info are removed successfully, false otherwise.