Package lumis.portal.preferences

Interface IPreferencesManager

All Known Subinterfaces:

IPreferencesManagerSPI

All Known Implementing Classes:

PreferencesManager

@StableMinor(version="16.1",
             sinceVersion="4.0")
public interface IPreferencesManager

Manager for handling user preferences operations.

Since:

4.0.7

Version:

$Revision: 26156 $ $Date: 2024-01-13 10:26:46 -0300 (Sat, 13 Jan 2024) $

Method Summary

Modifier and Type	Method	Description
void	delete(SessionConfig sessionConfig, java.lang.String resourceId, int resourceType, ITransaction transaction)	Deprecated. Since 10.2.0, replaced by deletePreferencesByServiceInterfaceInstanceId(String).
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. Since 10.2.0, replaced by getServiceInterfaceInstancePreferences(String, PreferencesLevel).
IPreferences	getServiceInterfaceInstancePreferences(java.lang.String serviceInterfaceInstanceId, PreferencesLevel level)	Returns the preferences for a specified resource at the specified level.

Method Detail

getPreferences

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

Deprecated.

Since 10.2.0, replaced by getServiceInterfaceInstancePreferences(String, PreferencesLevel).

Returns the user preferences for a specified resource.

Parameters:

sessionConfig - the user session information.

resourceId - the resource id.

resourceType - the resource type.

Returns:

the requested preferences.

Throws:

PortalException

Since:

4.0.7

getServiceInterfaceInstancePreferences

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

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

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

Since:

10.2.0

delete

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

Deprecated.

Since 10.2.0, replaced by deletePreferencesByServiceInterfaceInstanceId(String).

Deletes all preferences associated with the specified resource.

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

Since:

4.0.7

deletePreferencesByServiceInterfaceInstanceId

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

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

Parameters:

serviceInterfaceInstanceId - the service interface instance identifier.

Throws:

PortalException

Since:

10.2.0