nl.gx.webmanager.contentapi.event
Class PageEvent

java.lang.Object
  nl.gx.webmanager.contentapi.event.PageEvent

All Implemented Interfaces:

EntityEvent, Event

public class PageEvent
extends java.lang.Object
implements EntityEvent

This class represents a page event posted by the page service to allow all subscribers to this event to do something with that information. This may be updating timestamps, updating a search index, etc.

Author:

ivol

Nested Class Summary

Nested classes/interfaces inherited from interface nl.gx.webmanager.services.event.Event

Event.Type

Field Summary

Fields inherited from interface nl.gx.webmanager.services.event.EntityEvent

COPY, CREATE, DELETE, MOVE, RETRIEVE, UPDATE

Constructor Summary

PageEvent(Event.Type eventType, Page page, Page originalPage, java.lang.String eventAction, Page originalParentPage, java.lang.Object source)
Constructor of the page event.

PageEvent(Event.Type eventType, Page page, java.lang.String eventAction, Page originalParentPage, java.lang.Object source)
Constructor of the page event.

Method Summary

java.lang.Object	getEntity() Return the entity on which the action was performed.
java.lang.String	getEventAction() Returns the action that has been performed
Event.Type	getEventType() Type of event notification.
Page	getOriginalPage() Returns the original page associated with the event.
Page	getOriginalParentPage() Returns the original parent of the page associated with the event
Page	getPage() Returns the page associated with the event.
java.lang.Class<?>	getScope() The scope of the object on which the action is performed.
java.lang.Object	getSource() Returns the object that published the event
java.lang.String	toString() Returns String representing information on the event

Methods inherited from class java.lang.Object

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

Constructor Detail

PageEvent

public PageEvent(Event.Type eventType,
                 Page page,
                 java.lang.String eventAction,
                 Page originalParentPage,
                 java.lang.Object source)

Constructor of the page event.

Parameters:

eventType - The event type which can be either PRE or POST.

page - The page which is the result of the performed action.

eventAction - Action performed on the version. Typically one defined by the EntityEvent interface.

originalParentPage - The original page of which the original was a parent of. Useful in combination with EntityEvent.MOVE where page and original page are the same, and have a new parent.

source - The source object on which the event was published.

PageEvent

public PageEvent(Event.Type eventType,
                 Page page,
                 Page originalPage,
                 java.lang.String eventAction,
                 Page originalParentPage,
                 java.lang.Object source)

Constructor of the page event.

Parameters:

eventType - The event type which can be either PRE or POST.

page - The page which is the result of the performed action.

originalPage - The page on which the action is performed. Useful in combination with EntityEvent.COPY where page is not the same as original page.

eventAction - Action performed on the version. Typically one defined by the EntityEvent interface.

originalParentPage - The original page of which the original was a parent of. Useful in combination with EntityEvent.MOVE where page and original page are the same, and have a new parent.

source - The source object on which the event was published.

Method Detail

getOriginalParentPage

public Page getOriginalParentPage()

Returns the original parent of the page associated with the event

Returns:

the original parent of the page associated with the event. This can be null.

getPage

public Page getPage()

Returns the page associated with the event.

Returns:

the page associated with the event.

getOriginalPage

public Page getOriginalPage()

Returns the original page associated with the event.

Returns:

The original page.

getEntity

public java.lang.Object getEntity()

Description copied from interface: EntityEvent

Return the entity on which the action was performed.

Specified by:

getEntity in interface EntityEvent

Returns:

get the entity this event refers to.

getEventAction

public java.lang.String getEventAction()

Description copied from interface: Event

Returns the action that has been performed

Specified by:

getEventAction in interface Event

Returns:

the action that has been performed.

getEventType

public Event.Type getEventType()

Description copied from interface: Event

Type of event notification. This can be either PRE or POST. A PRE event is thrown just before the action is performed, a POST event immediately after.

Specified by:

getEventType in interface Event

Returns:

type of event notification.

getScope

public java.lang.Class<?> getScope()

Description copied from interface: Event

The scope of the object on which the action is performed. The scope indicates the object's type indicated by its Class

Specified by:

getScope in interface Event

Returns:

the class of the object that the action is performed on.

getSource

public java.lang.Object getSource()

Description copied from interface: Event

Returns the object that published the event

Specified by:

getSource in interface Event

Returns:

the source that fired the event (WCB ID).

toString

public java.lang.String toString()

Returns String representing information on the event

Overrides:

toString in class java.lang.Object

Returns:

String representing information on the event