Package lumis.portal.page

Class PageRenderDataChangedEvent

java.lang.Object

lumis.portal.event.AbstractPortalEvent

lumis.portal.event.AbstractTransactionalPortalEvent

lumis.portal.page.PageRenderDataChangedEvent

All Implemented Interfaces:

IPortalEvent

Direct Known Subclasses:

ChannelRenderDataChangedEvent, ServiceInterfaceInstanceRenderDataChangedEvent

@StableMinor(version="17.0",
             sinceVersion="4.2")
public class PageRenderDataChangedEvent
extends AbstractTransactionalPortalEvent

Event that indicates that the render data of some pages may have changed.

Since:

4.1.0

Version:

$Revision$ $Date$

Constructor Summary

Constructors

Constructor	Description
PageRenderDataChangedEvent(SessionConfig sessionConfig, java.util.Collection<PageConfig> pagesChanged, ITransaction transaction)

Method Summary

Modifier and Type	Method	Description
int	getExpirationLimit()	Returns the maximum number of web resource caches that can be expired in a single render data changed event.
java.util.Locale	getLocale()	Returns the locale where the change applies.
java.util.Collection<PageConfig>	getPagesChanged()	Returns the pages whose render data may have changed.
java.util.Map<java.lang.String,java.lang.String[]>	getParameters()	Returns the parameters where the change applies.
boolean	isAutomaticBulkExpiration()	Returns whether this event is an automatic bulk expiration.
void	setAutomaticBulkExpiration(boolean automaticBulkExpiration)	Sets whether this event is an automatic bulk expiration.
void	setExpirationLimit(int limit)	Sets the maximum number of web resource cache that can be expired in the render data event changes.
void	setLocale(java.util.Locale locale)	Sets the locale where the change applies.
void	setOperationType(PortalEventOperationType operationType)	Sets the type of operation that generated this event.
void	setParameters(java.util.Map<java.lang.String,java.lang.String[]> parameters)	Sets the parameters where the change applies.

Methods inherited from class lumis.portal.event.AbstractTransactionalPortalEvent

getSessionConfig, getTransaction

Methods inherited from class lumis.portal.event.AbstractPortalEvent

getEventGroups, getOperationType, setEventGroups

Methods inherited from class java.lang.Object

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

Methods inherited from interface lumis.portal.event.IPortalEvent

toString

Constructor Detail

PageRenderDataChangedEvent

public PageRenderDataChangedEvent(SessionConfig sessionConfig,
                                  java.util.Collection<PageConfig> pagesChanged,
                                  ITransaction transaction)

Method Detail

getPagesChanged

public java.util.Collection<PageConfig> getPagesChanged()
                                                 throws PortalException

Returns the pages whose render data may have changed.

Returns:

the pages whose render data may have changed.

Throws:

PortalException

Since:

4.1.0

getParameters

public java.util.Map<java.lang.String,java.lang.String[]> getParameters()

Returns the parameters where the change applies.

Returns:

the parameters or null if it applies independently to parameters.

Since:

4.2.0

setParameters

public void setParameters(java.util.Map<java.lang.String,java.lang.String[]> parameters)

Sets the parameters where the change applies.

Parameters:

parameters - the parameters value to set.

Since:

4.2.0

getLocale

public java.util.Locale getLocale()

Returns the locale where the change applies.

Returns:

the locale or null if it applies to all locales.

Since:

4.1.0

setLocale

public void setLocale(java.util.Locale locale)

Sets the locale where the change applies.

Parameters:

locale - the locale value to set.

Since:

4.1.0

setOperationType

public void setOperationType(PortalEventOperationType operationType)

Description copied from class: AbstractPortalEvent

Sets the type of operation that generated this event.

Overrides:

setOperationType in class AbstractPortalEvent

Parameters:

operationType - the operation type value to set.

getExpirationLimit

public int getExpirationLimit()

Returns the maximum number of web resource caches that can be expired in a single render data changed event.

The default value is the value defined on global configuration PortalContext.getHtmlGenerationConfig().

Returns:

the maximum number of web resource cache that can be expired in a single render data changed event.

Since:

6.2.0

setExpirationLimit

public void setExpirationLimit(int limit)

Sets the maximum number of web resource cache that can be expired in the render data event changes.

Parameters:

limit - the limit to be set.

Since:

6.2.0

isAutomaticBulkExpiration

public boolean isAutomaticBulkExpiration()

Returns whether this event is an automatic bulk expiration.

Some expiration events may be classified as automatic bulk expirations. Such events will not expire caches in queues with the included in automatic bulk expiration property disabled.

By default an event is not classified as an automatic bulk expiration.

Returns:

true if this event is an automatic bulk expiration, false otherwise.

Since:

7.0.0

setAutomaticBulkExpiration

public void setAutomaticBulkExpiration(boolean automaticBulkExpiration)

Sets whether this event is an automatic bulk expiration.

Some expiration events may be classified as automatic bulk expirations. Such events will not expire caches in queues with the included in automatic bulk expiration property disabled.

By default an event is not classified as an automatic bulk expiration.

Parameters:

automaticBulkExpiration - true to set this event as an automatic bulk expiration, false otherwise.

Since:

7.0.0