com.sapportals.portal.prt.component

Interface ICachablePortalComponent

All Superinterfaces:

IPortalComponent

All Known Subinterfaces:

ICacheDiscriminator, ICacheValidator

public interface ICachablePortalComponent
extends IPortalComponent

An ICachablePortalComponent is implemented by components that want to add caching capabilites to their behavior.

See Also:

IPortalComponent

Method Summary

CachingLevel	getCachingLevel(IPortalComponentRequest request) Gets the caching level.
boolean	hasExpired(IPortalComponentRequest request, long creationTime, long currentTime) Returns a boolean indicating whether the content of this component has expired.

Methods inherited from interface com.sapportals.portal.prt.component.IPortalComponent

destroy, init, service

Method Detail

hasExpired

boolean hasExpired(IPortalComponentRequest request,
                   long creationTime,
                   long currentTime)

Returns a boolean indicating whether the content of this component has expired.

Parameters:

request - the portal request.

creationTime - the creation time of this component.

currentTime - the actual time when the content of this component is requested by the runtime.

Returns:

true if the content has expired; false otherwise.

getCachingLevel

CachingLevel getCachingLevel(IPortalComponentRequest request)

Gets the caching level.

Parameters:

request - the portal request

Returns:

the caching level.

Access Rights

This class can be accessed from:

SC	DC	Public Part	ACH
[sap.com] EP-BASIS-API	[sap.com] epbc.prtapi._apideprecated	default	EP-PIN-PRT
[sap.com] EP-BASIS-API	[sap.com] tc/epbc/prt/lib/api	api	EP-PIN
[sap.com] EP-BASIS-API	[sap.com] tc/epbc/prt/api	api	EP-PIN