PageEvent (The Adobe Experience Manager SDK 2023.6.12441.20230623T133322Z-230600)

java.lang.Object
- com.day.cq.wcm.api.PageEvent

All Implemented Interfaces:

java.io.Serializable
```
public final class PageEvent
extends java.lang.Object
implements java.io.Serializable
```
This event is fired for each page change.

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type Field Description

static java.lang.String EVENT_TOPIC
Event topic for page modification events.

Constructor Summary

Constructors
Constructor	Description
`PageEvent(PageModification mod)`
`PageEvent(java.util.List<PageModification> mods)`
`PageEvent(java.util.List<PageModification> mods, boolean isLocal)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static PageEvent`	`fromEvent(Event evt)`	Convert an OSGi event to a page event if possible.
`java.util.Iterator<PageModification>`	`getModifications()`	Get the list of modifications.
`boolean`	`isLocal()`	Is this a local or a cluster event?
`Event`	`toEvent()`	Create a distributable event.
`Event`	`toNonDistributableEvent()`	Create a non distributable event.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - EVENT_TOPIC
```
public static final java.lang.String EVENT_TOPIC
```
    Event topic for page modification events.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - PageEvent
```
public PageEvent(PageModification mod)
```
  - PageEvent
```
public PageEvent(java.util.List<PageModification> mods)
```
  - PageEvent
```
public PageEvent(java.util.List<PageModification> mods,
                 boolean isLocal)
```
- Method Detail
  - getModifications
```
public java.util.Iterator<PageModification> getModifications()
```
    Get the list of modifications.
    
    Returns:
    
    An iterator for the modifications.
  - isLocal
```
public boolean isLocal()
```
    Is this a local or a cluster event?
    
    Returns:
    
    true if this is a local event
  - fromEvent
```
public static PageEvent fromEvent(Event evt)
```
    Convert an OSGi event to a page event if possible.
    
    Parameters:
    
    evt - The OSGi event.
    
    Returns:
    
    The page even or null.
  - toEvent
```
public Event toEvent()
```
    Create a distributable event.
    
    Returns:
    
    An event.
  - toNonDistributableEvent
```
public Event toNonDistributableEvent()
```
    Create a non distributable event.
    
    Returns:
    
    An event.