com.sssw.fw.usermgr.api
Interface EbiUserPreferenceDelegate

All Superinterfaces:

EbiDelegate

public interface EbiUserPreferenceDelegate

extends EbiDelegate

User Preference Delegate that is Provided as a facade to access user preference related information either from the local personalize manager or through EJB api provided by the user service.

Fields inherited from interface com.sssw.fw.api.EbiDelegate

SERVICE_LOCAL, SERVICE_REMOTE

Method Summary

boolean	addUserPreference(EbiContext context, EbiUserPreferenceInfo userpref) Adds user preference info of a component for a specified user.
EbiUserPreferenceInfo	createUserPreferenceInfo() Gets a new user preference info object for use in user preference creation.
EbiUserPreferenceInfo	getUserPreference(EbiContext context, String userIID, String elementType, String elementID) Gets user preference info for a component.
EbiUserPreferenceInfo[]	getUserPreferences(EbiContext context, String userIID) Gets user preference info for a user.
EbiUserPreferenceInfo[]	getUserPreferences(EbiContext context, String userIID, String elementType) Gets user preferences for an element type for a user.
boolean	modifyUserPreference(EbiContext context, EbiUserPreferenceInfo userpref) Modifies user preference info of a component for a specified user.
boolean	removeUserPreference(EbiContext context, String userIID, String elementType, String elementID) Removes user preference info of a element for a specified user.
boolean	removeUserPreferences(EbiContext context, String userIID) Removes user preference info of all components for a specified user.
boolean	removeUserPreferences(EbiContext context, String userIID, String elementType) Removes user preference info of a specified element type and a specified user.

Methods implemented from interface com.sssw.fw.api.EbiDelegate

getName

Method Detail

createUserPreferenceInfo

public EbiUserPreferenceInfo createUserPreferenceInfo()
                                               throws EboUnrecoverableSystemException,
                                                      EboSecurityException

Gets a new user preference info object for use in user preference creation.

Returns:

a new EbiUserPreferenceInfo object.

getUserPreference

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

Gets user preference info for a component.

Parameters:

context - an EbiContext object.

userIID - a user UUID.

elementType - an element type

elementID - an element ID.

Returns:

an EbiUserPreferenceInfo object for the specified user and specified element.

getUserPreferences

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

Gets user preferences for an element type for a user.

Parameters:

context - an EbiContext object.

userIID - a user UUID.

elementType - an element type.

Returns:

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

getUserPreferences

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

Gets user preference info for a user. (all components)

Parameters:

context - an EbiContext object.

userIID - a user UUID.

Returns:

an array of EbiUserPreference objects for the specified user.

addUserPreference

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

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

Parameters:

context - an EbiContext object.

userpref - an EbiUserPreference object.

modifyUserPreference

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

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

Parameters:

context - an EbiContext object.

userpref - an EbiUserPreference object.

removeUserPreference

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

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

Parameters:

context - an EbiContext object.

userIID - a user UUID.

elementType -

elementID -

removeUserPreferences

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

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

Parameters:

context - an EbiContext object.

userIID - a user UUID.

removeUserPreferences

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

Removes user preference info of a specified element type and a specified user.

Parameters:

context - an EbiContext object.

userIID - a user UUID.

elementType - an element type.