Package lumis.portal.preferences
Class PreferencesManager
- java.lang.Object
-
- lumis.portal.preferences.PreferencesManager
-
- All Implemented Interfaces:
IPreferencesManager
,IPreferencesManagerSPI
public class PreferencesManager extends 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
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description void
copySharedInterfaceInstancePreferences(String srcInterfaceInstanceId, String destInterfaceInstanceId)
Copies the shared interface instance preferences from an interface instance to another.void
delete(SessionConfig sessionConfig, String resourceId, int resourceType, ITransaction transaction)
Deprecated.void
deletePreferencesByServiceInterfaceInstanceId(String serviceInterfaceInstanceId)
Deletes all non-structure level preferences associated with the specified service interface instance.IPreferences
getPreferences(SessionConfig sessionConfig, String resourceId, int resourceType)
Deprecated.IPreferences
getServiceInterfaceInstancePreferences(String serviceInterfaceInstanceId, PreferencesLevel level)
Returns the preferences for a specified resource at the specified level.void
setSharedInterfaceInstancePreferences(String interfaceInstanceId, Map<String,String[]> sharedPreferences)
Sets the shared interface instance preferences for the given interface instance identifier.
-
-
-
Method Detail
-
getPreferences
@Deprecated public IPreferences getPreferences(SessionConfig sessionConfig, String resourceId, int resourceType) throws PortalException
Deprecated.Description copied from interface:IPreferencesManager
Returns the user preferences for a specified resource.- Specified by:
getPreferences
in interfaceIPreferencesManager
- Parameters:
sessionConfig
- the user session information.resourceId
- the resource id.resourceType
- the resource type.- Returns:
- the requested preferences.
- Throws:
PortalException
-
getServiceInterfaceInstancePreferences
public IPreferences getServiceInterfaceInstancePreferences(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 interfaceIPreferencesManager
- Parameters:
serviceInterfaceInstanceId
- the service interface instance identifier.level
- the storage level of the preferences to be returned. For user level, the user of thecurrent session
is used.- Returns:
- the requested preferences.
- Throws:
PortalException
-
delete
@Deprecated public void delete(SessionConfig sessionConfig, 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 interfaceIPreferencesManager
- Parameters:
sessionConfig
- the user session information.resourceId
- the resource id.resourceType
- the resource type. One of theIPreferences
constants.transaction
- transaction for persistence access.- Throws:
PortalException
-
deletePreferencesByServiceInterfaceInstanceId
public void deletePreferencesByServiceInterfaceInstanceId(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 interfaceIPreferencesManager
- Parameters:
serviceInterfaceInstanceId
- the service interface instance identifier.- Throws:
PortalException
-
copySharedInterfaceInstancePreferences
public void copySharedInterfaceInstancePreferences(String srcInterfaceInstanceId, 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 interfaceIPreferencesManagerSPI
- Parameters:
srcInterfaceInstanceId
- the source interface instance identifier.destInterfaceInstanceId
- the destination interface instance identifier.- Throws:
PortalException
-
setSharedInterfaceInstancePreferences
public void setSharedInterfaceInstancePreferences(String interfaceInstanceId, Map<String,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 interfaceIPreferencesManagerSPI
- Parameters:
interfaceInstanceId
- the interface instance for which to set shared preferencessharedPreferences
- the shared preferences- Throws:
PortalException
-
-