com.ibm.commerce.pagelayout.layout.cache

Class LayoutCache

java.lang.Object

com.ibm.commerce.pagelayout.layout.cache.LayoutCache

public class LayoutCache
extends java.lang.Object

The data cache for LayoutType logical SDO.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COPYRIGHT IBM copy right field.

Constructor Summary

Constructors

Constructor and Description
LayoutCache()

Method Summary

Modifier and Type	Method and Description
static com.ibm.commerce.pagelayout.facade.datatypes.LayoutType	getDefaultLayoutByDeviceClassAndLayoutGroup(java.lang.String deviceClass, java.lang.String layoutGroup, java.lang.String accessProfile) This method fetches the default layout based on the device class and layout group specified.
static com.ibm.commerce.pagelayout.facade.datatypes.LayoutType	getDefaultLayoutByDeviceClassLayoutGroupAndManagingTool(java.lang.String deviceClass, java.lang.String layoutGroup, java.lang.String managingTool, java.lang.String accessProfile) This method retrieves the default layout for a given device class, layout group and managing tool.
static com.ibm.commerce.pagelayout.facade.datatypes.LayoutType	getLayoutByUniqueID(java.lang.String uniqueID, java.lang.String accessProfile) This method retrieves the layout based on the unique ID specified.
static boolean	isCachingEnabledForAccessProfile(java.lang.String accessProfile) This method checks if caching is enabled for the access profile specified.

Methods inherited from class java.lang.Object

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

Field Detail

COPYRIGHT

public static final java.lang.String COPYRIGHT

IBM copy right field.

See Also:

Constant Field Values

Constructor Detail

LayoutCache

public LayoutCache()

Method Detail

isCachingEnabledForAccessProfile

public static boolean isCachingEnabledForAccessProfile(java.lang.String accessProfile)

This method checks if caching is enabled for the access profile specified. Caching is configured in the CachedAccessProfilesForLayout extended configuration.

Parameters:

accessProfile - The access profile to check

Returns:

True, if caching is enabled. False, otherwise.

getLayoutByUniqueID

public static com.ibm.commerce.pagelayout.facade.datatypes.LayoutType getLayoutByUniqueID(java.lang.String uniqueID,
                                                                                          java.lang.String accessProfile)
                                                                                   throws PageLayoutApplicationException

This method retrieves the layout based on the unique ID specified.

Parameters:

uniqueID - The unique ID of the layout.

accessProfile - The access profile to be used while fetching the widget.

Returns:

The LayoutType logical SDO.

Throws:

PageLayoutApplicationException - When the layout retrieval fails.

getDefaultLayoutByDeviceClassAndLayoutGroup

public static com.ibm.commerce.pagelayout.facade.datatypes.LayoutType getDefaultLayoutByDeviceClassAndLayoutGroup(java.lang.String deviceClass,
                                                                                                                  java.lang.String layoutGroup,
                                                                                                                  java.lang.String accessProfile)
                                                                                                           throws PageLayoutApplicationException

This method fetches the default layout based on the device class and layout group specified. This method assumes the managing tool to be default.

Parameters:

deviceClass - The device class for the layout.

layoutGroup - The layout group for the layout.

accessProfile - The access profile to be used for fetching the layout.

Returns:

The LayoutType logical SDO.

Throws:

PageLayoutApplicationException - When the retrieval fails.

getDefaultLayoutByDeviceClassLayoutGroupAndManagingTool

public static com.ibm.commerce.pagelayout.facade.datatypes.LayoutType getDefaultLayoutByDeviceClassLayoutGroupAndManagingTool(java.lang.String deviceClass,
                                                                                                                              java.lang.String layoutGroup,
                                                                                                                              java.lang.String managingTool,
                                                                                                                              java.lang.String accessProfile)
                                                                                                                       throws PageLayoutApplicationException

This method retrieves the default layout for a given device class, layout group and managing tool.

Parameters:

deviceClass - The device class. Cannot be null.

layoutGroup - The layout group value. Cannot be null.

managingTool - The managing tool value. Cannot be null.

accessProfile - The access profile.

Returns:

The default layout.

Throws:

PageLayoutApplicationException