com.sssw.fw.usermgr.api
Interface EbiPersonalizeManager

public interface EbiPersonalizeManager

Provides an interface for the user personalize manager.

Method Summary

boolean	addGroupPreference(EbiContext ctx, EbiGroupPreferenceInfo userpref) Adds a group preference info.
boolean	addGroupProfile(EbiContext ctx, EbiGroupProfileInfo info) Deprecated.
boolean	addPersonalizedProfile(EbiContext ctx, EbiUserProfileInfo info) Deprecated.
boolean	addUserPreference(EbiContext ctx, EbiUserPreferenceInfo userpref) Adds user preference info of a component for a specified user.
boolean	addUserToGroupProfile(EbiContext ctx, String groupProfileName, String userID, String realmName) Deprecated.
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.
EbiGroupProfileInfo	getGroupProfileInfo(EbiContext ctx, String profileName) Deprecated.
EbiGroupProfileInfo[]	getGroupProfileInfoList(EbiContext ctx) Deprecated.
EbiGroupProfileInfo[]	getGroupProfilesByUser(EbiContext ctx, String userID, String realmName) Deprecated.
EbiUserProfileInfo	getPersonalizedProfileInfo(EbiContext ctx, String userIID, String profileName) Deprecated.
EbiUserProfileInfo	getPersonalizedProfileInfo(EbiContext ctx, String userIID, String profileName, boolean flush) Deprecated.
EbiUserProfileInfo[]	getPersonalizedProfileInfoList(EbiContext ctx, String userIID) Deprecated.
EbiRealmUser[]	getUserListByGroupProfile(EbiContext ctx, String groupProfileName) Deprecated.
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 for a user.
EbiUserPreferenceInfo[]	getUserPreferences(EbiContext ctx, String userIID, String elementType) Gets user preference info related to a particular element type for a user.
boolean	isGroupProfileMember(EbiContext context, String groupProfileName, String userID, String realmName) Deprecated.
boolean	isValidGroupProfile(EbiContext context, String profileName) Deprecated.
boolean	isValidPersonalizedProfile(EbiContext context, String userIID, String profileName) Deprecated.
boolean	modifyGroupPreference(EbiContext ctx, EbiGroupPreferenceInfo groupPref) Modifies a group preference info of a specified element.
boolean	modifyGroupProfile(EbiContext ctx, EbiGroupProfileInfo info) Deprecated.
boolean	modifyPersonalizedProfile(EbiContext ctx, EbiUserProfileInfo info) Deprecated.
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	removeGroupProfile(EbiContext ctx, String groupProfileName) Deprecated.
boolean	removePersonalizedProfiles(EbiContext ctx, String userIID, String profileName) Deprecated.
boolean	removeUserFromGroupProfile(EbiContext ctx, String groupProfileName, String userID, String realmName) Deprecated.
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

isValidPersonalizedProfile

public boolean isValidPersonalizedProfile(EbiContext context,
                                          String userIID,
                                          String profileName)
                                   throws EboUnrecoverableSystemException,
                                          EboSecurityException

Deprecated.

Checks if the specified personalized profile is valid.

Parameters:

ctx - An EbiContext object.

userIID - A UUID for a specified user.

profileName - A profile name.

getPersonalizedProfileInfo

public EbiUserProfileInfo getPersonalizedProfileInfo(EbiContext ctx,
                                                     String userIID,
                                                     String profileName)
                                              throws EboUnrecoverableSystemException,
                                                     EboSecurityException

Deprecated.

Gets a personalized profile info for a specified user.

Parameters:

ctx - An EbiContext object.

userIID - A UUID for a specified user.

profileName - A profile name.

getPersonalizedProfileInfo

public EbiUserProfileInfo getPersonalizedProfileInfo(EbiContext ctx,
                                                     String userIID,
                                                     String profileName,
                                                     boolean flush)
                                              throws EboUnrecoverableSystemException,
                                                     EboSecurityException

Deprecated.

Gets a personalized profile info for a specified user.

Parameters:

ctx - An EbiContext object.

userIID - A UUID for a specified user.

profileName - A profile name.

flush - If true, get data from persistence mgr, otherwise try to get from cache first.

getPersonalizedProfileInfoList

public EbiUserProfileInfo[] getPersonalizedProfileInfoList(EbiContext ctx,
                                                           String userIID)
                                                    throws EboUnrecoverableSystemException,
                                                           EboSecurityException

Deprecated.

Gets a list of personalized profile info for a specified user.

Parameters:

ctx - An EbiContext object.

userIID - A UUID for the specified user.

Returns:

An array of EbiUserProfileInfo objects for the specified user.

addPersonalizedProfile

public boolean addPersonalizedProfile(EbiContext ctx,
                                      EbiUserProfileInfo info)
                               throws EboUnrecoverableSystemException,
                                      EboSecurityException

Deprecated.

Adds a personalized profile for a specified user.

Parameters:

ctx - An EbiContext object.

info - An EbiUserProfileInfo object.

Returns:

true if the new personalized profile info is added successfully, false otherwise.

modifyPersonalizedProfile

public boolean modifyPersonalizedProfile(EbiContext ctx,
                                         EbiUserProfileInfo info)
                                  throws EboUnrecoverableSystemException,
                                         EboSecurityException

Deprecated.

Modifies a personalized profile for a specified user.

Parameters:

ctx - An EbiContext object.

info - An EbiUserProfileInfo object.

Returns:

true if the personalized profile info is modified successfully, false otherwise.

removePersonalizedProfiles

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

Deprecated.

Removes personalized profile(s) for a specified user.

Parameters:

ctx - An EbiContext object.

userIID - A UUID for the specified user.

profileName - The name of the personalized profile to be removed for the specified user. If profileName is null then all personalized profiles for the specified user are removed.

Returns:

true if the personalized profile for the user is removed successfully, false otherwise.

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 - An element 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 for a user. (for all elements)

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 related to a particular element type for a user. (for all elements)

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 ID (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 - Type of element.

elementID - Element 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 ID (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.

isValidGroupProfile

public boolean isValidGroupProfile(EbiContext context,
                                   String profileName)
                            throws EboUnrecoverableSystemException,
                                   EboSecurityException

Deprecated.

Checks to see if the specified group profile is valid.

Parameters:

ctx - An EbiContext object.

profileName - A group profile name.

getGroupProfileInfo

public EbiGroupProfileInfo getGroupProfileInfo(EbiContext ctx,
                                               String profileName)
                                        throws EboUnrecoverableSystemException,
                                               EboSecurityException

Deprecated.

Gets a group profile info.

Parameters:

ctx - An EbiContext object.

profileName - A group profile name.

Returns:

EbiGroupProfileInfo Object for specified group profile name.

getGroupProfileInfoList

public EbiGroupProfileInfo[] getGroupProfileInfoList(EbiContext ctx)
                                              throws EboUnrecoverableSystemException,
                                                     EboSecurityException

Deprecated.

Gets a list of all group profile info objects.

Parameters:

ctx - An EbiContext object.

Returns:

An array of EbiGroupProfileInfo objects that can be accessed by the current user in the session.

addGroupProfile

public boolean addGroupProfile(EbiContext ctx,
                               EbiGroupProfileInfo info)
                        throws EboUnrecoverableSystemException,
                               EboSecurityException

Deprecated.

Adds a group profile.

Parameters:

ctx - An EbiContext object.

info - An EbiGroupProfileInfo object.

Returns:

true if the new group profile info is added successfully, false otherwise.

modifyGroupProfile

public boolean modifyGroupProfile(EbiContext ctx,
                                  EbiGroupProfileInfo info)
                           throws EboUnrecoverableSystemException,
                                  EboSecurityException

Deprecated.

Modifies a group profile.

Parameters:

ctx - An EbiContext object.

info - An EbiGroupProfileInfo object.

Returns:

true if the group profile info is modified successfully, false otherwise.

removeGroupProfile

public boolean removeGroupProfile(EbiContext ctx,
                                  String groupProfileName)
                           throws EboUnrecoverableSystemException,
                                  EboSecurityException

Deprecated.

Removes a group profile.

Parameters:

ctx - An EbiContext object.

profileName - The name of the group profile to be removed.

Returns:

true if the group profile is removed successfully, false otherwise.

addUserToGroupProfile

public boolean addUserToGroupProfile(EbiContext ctx,
                                     String groupProfileName,
                                     String userID,
                                     String realmName)
                              throws EboUnrecoverableSystemException,
                                     EboSecurityException

Deprecated.

Adds a user to the specified group profile.

Parameters:

groupProfileName - The name of the specified group profile.

usrID - A userID

realmName - The name of the realm that the user is defined in the directory service (optional; if null, the primary realm is assumed).

Returns:

true if the user is added to the group profile successfully.

removeUserFromGroupProfile

public boolean removeUserFromGroupProfile(EbiContext ctx,
                                          String groupProfileName,
                                          String userID,
                                          String realmName)
                                   throws EboUnrecoverableSystemException,
                                          EboSecurityException

Deprecated.

Removes a user from the specified group profile.

Parameters:

groupProfileName - The name of the specified group profile.

userID - A userID.

realmName - The name of the realm that user is defined in the directory service (optional; if null, the primary realm is assumed).

Returns:

true if the user is removed from the group profile successfully.

getUserListByGroupProfile

public EbiRealmUser[] getUserListByGroupProfile(EbiContext ctx,
                                                String groupProfileName)
                                         throws EboUnrecoverableSystemException,
                                                EboSecurityException

Deprecated.

Gets a list of users for the specified group profile.

Parameters:

groupProfileName - The name of the specified group profile.

Returns:

A list of EbiUserInfo objects for the specified group profile.

getGroupProfilesByUser

public EbiGroupProfileInfo[] getGroupProfilesByUser(EbiContext ctx,
                                                    String userID,
                                                    String realmName)
                                             throws EboUnrecoverableSystemException,
                                                    EboSecurityException

Deprecated.

Gets a list of group profiles for the specified user.

Parameters:

userID - A user ID.

realmName - The name of the realm that user is defined in the directory service (optional; if null, the primary realm is assumed).

Returns:

An array of EbiGroupProfileInfo objects for the specified user.

isGroupProfileMember

public boolean isGroupProfileMember(EbiContext context,
                                    String groupProfileName,
                                    String userID,
                                    String realmName)
                             throws EboUnrecoverableSystemException,
                                    EboSecurityException

Deprecated.

Check if a user is a member of a group profile.

Parameters:

groupProfileName - The name of a group profile.

userID - A user ID.

realmName - The name of the realm that user is defined in the directory service (optional; if null, the primary realm is assumed).