Package lumis.portal.preferences

Class PreferencesManager

java.lang.Object

lumis.portal.preferences.PreferencesManager

All Implemented Interfaces:

IPreferencesManager, IPreferencesManagerSPI

public class PreferencesManager
extends java.lang.Object
implements IPreferencesManagerSPI

Preferences manager implementation.

Since:

4.0.7

Version:

$Revision: 23668 $ $Date: 2020-03-14 17:37:34 -0300 (Sat, 14 Mar 2020) $

Constructor Summary

Constructors

Constructor	Description
PreferencesManager()

Method Summary

Modifier and Type	Method	Description
void	copySharedInterfaceInstancePreferences(java.lang.String srcInterfaceInstanceId, java.lang.String destInterfaceInstanceId)	Copies the shared interface instance preferences from an interface instance to another.
void	delete(SessionConfig sessionConfig, java.lang.String resourceId, int resourceType, ITransaction transaction)	Deprecated.
void	deletePreferencesByServiceInterfaceInstanceId(java.lang.String serviceInterfaceInstanceId)	Deletes all non-structure level preferences associated with the specified service interface instance.
IPreferences	getPreferences(SessionConfig sessionConfig, java.lang.String resourceId, int resourceType)	Deprecated.
IPreferences	getServiceInterfaceInstancePreferences(java.lang.String serviceInterfaceInstanceId, PreferencesLevel level)	Returns the preferences for a specified resource at the specified level.
void	setSharedInterfaceInstancePreferences(java.lang.String interfaceInstanceId, java.util.Map<java.lang.String,java.lang.String[]> sharedPreferences)	Sets the shared interface instance preferences for the given interface instance identifier.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PreferencesManager

public PreferencesManager()

Method Detail

getPreferences

@Deprecated
public IPreferences getPreferences(SessionConfig sessionConfig,
                                   java.lang.String resourceId,
                                   int resourceType)
                            throws PortalException

Deprecated.

Description copied from interface: IPreferencesManager

Returns the user preferences for a specified resource.

Specified by:

getPreferences in interface IPreferencesManager

Parameters:

sessionConfig - the user session information.

resourceId - the resource id.

resourceType - the resource type.

Returns:

the requested preferences.

Throws:

PortalException

getServiceInterfaceInstancePreferences

public IPreferences getServiceInterfaceInstancePreferences(java.lang.String serviceInterfaceInstanceId,
                                                           PreferencesLevel level)
                                                    throws PortalException

Description copied from interface: IPreferencesManager

Returns the preferences for a specified resource at the specified level.

Specified by:

getServiceInterfaceInstancePreferences in interface IPreferencesManager

Parameters:

serviceInterfaceInstanceId - the service interface instance identifier.

level - the storage level of the preferences to be returned. For user level, the user of the current session is used.

Returns:

the requested preferences.

Throws:

PortalException

delete

@Deprecated
public void delete(SessionConfig sessionConfig,
                   java.lang.String resourceId,
                   int resourceType,
                   ITransaction transaction)
            throws PortalException

Deprecated.

Description copied from interface: IPreferencesManager

Deletes all preferences associated with the specified resource.

Specified by:

delete in interface IPreferencesManager

Parameters:

sessionConfig - the user session information.

resourceId - the resource id.

resourceType - the resource type. One of the IPreferences constants.

transaction - transaction for persistence access.

Throws:

PortalException

deletePreferencesByServiceInterfaceInstanceId

public void deletePreferencesByServiceInterfaceInstanceId(java.lang.String serviceInterfaceInstanceId)
                                                   throws PortalException

Description copied from interface: IPreferencesManager

Deletes all non-structure level preferences associated with the specified service interface instance.

Specified by:

deletePreferencesByServiceInterfaceInstanceId in interface IPreferencesManager

Parameters:

serviceInterfaceInstanceId - the service interface instance identifier.

Throws:

PortalException

copySharedInterfaceInstancePreferences

public void copySharedInterfaceInstancePreferences(java.lang.String srcInterfaceInstanceId,
                                                   java.lang.String destInterfaceInstanceId)
                                            throws PortalException

Description copied from interface: IPreferencesManagerSPI

Copies the shared interface instance preferences from an interface instance to another.

Specified by:

copySharedInterfaceInstancePreferences in interface IPreferencesManagerSPI

Parameters:

srcInterfaceInstanceId - the source interface instance identifier.

destInterfaceInstanceId - the destination interface instance identifier.

Throws:

PortalException

setSharedInterfaceInstancePreferences

public void setSharedInterfaceInstancePreferences(java.lang.String interfaceInstanceId,
                                                  java.util.Map<java.lang.String,java.lang.String[]> sharedPreferences)
                                           throws PortalException

Description copied from interface: IPreferencesManagerSPI

Sets the shared interface instance preferences for the given interface instance identifier. All existing shared preferences are removed or set to the given values.

Specified by:

setSharedInterfaceInstancePreferences in interface IPreferencesManagerSPI

Parameters:

interfaceInstanceId - the interface instance for which to set shared preferences

sharedPreferences - the shared preferences

Throws:

PortalException