de.innovationgate.wgpublisher.hdb

Class HDBModelEvent

java.lang.Object

de.innovationgate.wgpublisher.hdb.HDBModelEvent

Direct Known Subclasses:

HDBModelContentEvent, HDBModelHDBEvent

public abstract class HDBModelEvent
extends java.lang.Object

Generic interface for object "event" in HDBModel event scripts

Constructor Summary

Constructors

Constructor and Description
HDBModelEvent()

Method Summary

Methods

Modifier and Type	Method and Description
abstract void	cancel(java.lang.String message) Cancels the event
abstract void	cancel(java.lang.String message, java.lang.Throwable throwable) Cancels the event, giving an exception as reason
abstract de.innovationgate.webgate.api.WGContent	getContent() The content that triggered the event execution, i.e. on which the event happened.
abstract java.lang.String	getContentClass() The content class of the content that triggered the event execution, i.e. on which the event happened.
java.lang.Object	getCustomParam() Returns a custom parameter object that may be passed to the operation.
abstract de.innovationgate.webgate.api.WGHierarchicalDatabase	getDb() The HDB database
abstract de.innovationgate.webgate.api.WGContentKey	getDeletedContentKey() In case of an deletion event servers the content key of the deleted content
abstract de.innovationgate.webgate.api.WGContent	getEventReceiver() The content that owns the event currently executed.
Form	getForm() Returns a WebTML form that was passed to this HDBModel operation
abstract de.innovationgate.webgate.api.WGContent	getMoveTargetContent() On move events: The target content under which the document will get moved
abstract HDBModelParams	getParameter() The HDBModel param passed to this HDBModel operation Public for backward compatibility of pre-release event scripts.
abstract java.lang.String	getType() The HDBModel event type.
void	setCustomParam(java.lang.Object customParam) Sets a custom parameter object to the event.

Methods inherited from class java.lang.Object

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

Constructor Detail

HDBModelEvent

public HDBModelEvent()

Method Detail

cancel

public abstract void cancel(java.lang.String message,
          java.lang.Throwable throwable)
                     throws java.lang.Exception

Cancels the event, giving an exception as reason

Parameters:

message - The cancelling message

throwable - A causing exception

Throws:

java.lang.Exception

cancel

public abstract void cancel(java.lang.String message)
                     throws java.lang.Exception

Cancels the event

Parameters:

message - The cancelling message

Throws:

java.lang.Exception

getEventReceiver

public abstract de.innovationgate.webgate.api.WGContent getEventReceiver()
                                                                  throws de.innovationgate.webgate.api.WGAPIException

The content that owns the event currently executed. On hierarchical events this may NOT be the content on which the event happened but a parent of it that wants to react on the event.

Throws:

de.innovationgate.webgate.api.WGAPIException

getContent

public abstract de.innovationgate.webgate.api.WGContent getContent()
                                                            throws de.innovationgate.webgate.api.WGAPIException

The content that triggered the event execution, i.e. on which the event happened. On hierarchical events this may NOT be the content whose event is executed but some content in its sub hierarchy. This may be null if the event happens while the triggering content does not exist (preCreate, postDelete)

Throws:

de.innovationgate.webgate.api.WGAPIException

getContentClass

public abstract java.lang.String getContentClass()
                                          throws de.innovationgate.webgate.api.WGAPIException

The content class of the content that triggered the event execution, i.e. on which the event happened. On hierarchical events this may NOT be the content whose event is executed but some content in its sub hierarchy. This is filled even when the triggering content does not exist while the event happens (preCreate, postDelete)

Returns:

The content class

Throws:

de.innovationgate.webgate.api.WGAPIException

getDb

public abstract de.innovationgate.webgate.api.WGHierarchicalDatabase getDb()
                                                                    throws de.innovationgate.webgate.api.WGAPIException

The HDB database

Throws:

de.innovationgate.webgate.api.WGAPIException

getParameter

public abstract HDBModelParams getParameter()
                                     throws de.innovationgate.webgate.api.WGAPIException

The HDBModel param passed to this HDBModel operation Public for backward compatibility of pre-release event scripts.

Throws:

de.innovationgate.webgate.api.WGAPIException

getMoveTargetContent

public abstract de.innovationgate.webgate.api.WGContent getMoveTargetContent()
                                                                      throws de.innovationgate.webgate.api.WGAPIException

On move events: The target content under which the document will get moved

Throws:

de.innovationgate.webgate.api.WGAPIException

getType

public abstract java.lang.String getType()

The HDBModel event type. Equals constants HDBModel.EVENT_*

getForm

public Form getForm()
             throws de.innovationgate.webgate.api.WGAPIException

Returns a WebTML form that was passed to this HDBModel operation

Throws:

de.innovationgate.webgate.api.WGAPIException

getCustomParam

public java.lang.Object getCustomParam()
                                throws de.innovationgate.webgate.api.WGAPIException

Returns a custom parameter object that may be passed to the operation. The object can also be used to transport custom data accross the events of the operation.

Throws:

de.innovationgate.webgate.api.WGAPIException

setCustomParam

public void setCustomParam(java.lang.Object customParam)
                    throws de.innovationgate.webgate.api.WGAPIException

Sets a custom parameter object to the event. The parameter object will be retrievable on all following events of this operation via getCustomParam().

Throws:

de.innovationgate.webgate.api.WGAPIException

getDeletedContentKey

public abstract de.innovationgate.webgate.api.WGContentKey getDeletedContentKey()
                                                                         throws de.innovationgate.webgate.api.WGAPIException

In case of an deletion event servers the content key of the deleted content

Throws:

de.innovationgate.webgate.api.WGAPIException