Package com.day.cq.wcm.api
Class PageEvent
- 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.SerializableThis event is fired for each page change.- See Also:
 - Serialized Form
 
 
- 
- 
Field Summary
Fields Modifier and Type Field Description static java.lang.StringEVENT_TOPICEvent 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 PageEventfromEvent(org.osgi.service.event.Event evt)Convert an OSGi event to a page event if possible.java.util.Iterator<PageModification>getModifications()Get the list of modifications.booleanisLocal()Is this a local or a cluster event?org.osgi.service.event.EventtoEvent()Create a distributable event.org.osgi.service.event.EventtoNonDistributableEvent()Create a non distributable event. 
 - 
 
- 
- 
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:
 trueif this is a local event
 
- 
fromEvent
public static PageEvent fromEvent(org.osgi.service.event.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 org.osgi.service.event.Event toEvent()
Create a distributable event.- Returns:
 - An event.
 
 
- 
toNonDistributableEvent
public org.osgi.service.event.Event toNonDistributableEvent()
Create a non distributable event.- Returns:
 - An event.
 
 
 - 
 
 -