de.innovationgate.wgpublisher.hdb

Class HDBModelContentEvent

java.lang.Object

de.innovationgate.wgpublisher.hdb.HDBModelEvent

de.innovationgate.wgpublisher.hdb.HDBModelContentEvent

public class HDBModelContentEvent
extends HDBModelEvent

Object "event" in HDBModel event scripts that are based on content events

Constructor Summary

Constructors

Constructor and Description
HDBModelContentEvent(de.innovationgate.webgate.api.WGContent content, java.lang.String modelEventType, HDBModelParams parameter, boolean cancelable)

Method Summary

Methods

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

Methods inherited from class de.innovationgate.wgpublisher.hdb.HDBModelEvent

getCustomParam, getForm, setCustomParam

Methods inherited from class java.lang.Object

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

Constructor Detail

HDBModelContentEvent

public HDBModelContentEvent(de.innovationgate.webgate.api.WGContent content,
                    java.lang.String modelEventType,
                    HDBModelParams parameter,
                    boolean cancelable)

Method Detail

getEventReceiver

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

Description copied from class: HDBModelEvent

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.

Specified by:

getEventReceiver in class HDBModelEvent

Throws:

de.innovationgate.webgate.api.WGAPIException

cancel

public void cancel(java.lang.String message,
          java.lang.Throwable throwable)
            throws de.innovationgate.webgate.api.WGCancelledException

Description copied from class: HDBModelEvent

Cancels the event, giving an exception as reason

Specified by:

cancel in class HDBModelEvent

Parameters:

message - The cancelling message

throwable - A causing exception

Throws:

de.innovationgate.webgate.api.WGCancelledException

cancel

public void cancel(java.lang.String message)
            throws de.innovationgate.webgate.api.WGCancelledException

Description copied from class: HDBModelEvent

Cancels the event

Specified by:

cancel in class HDBModelEvent

Parameters:

message - The cancelling message

Throws:

de.innovationgate.webgate.api.WGCancelledException

getDb

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

Description copied from class: HDBModelEvent

The HDB database

Specified by:

getDb in class HDBModelEvent

Throws:

de.innovationgate.webgate.api.WGAPIException

getContent

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

Description copied from class: HDBModelEvent

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)

Specified by:

getContent in class HDBModelEvent

Throws:

de.innovationgate.webgate.api.WGAPIException

getParameter

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

Description copied from class: HDBModelEvent

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

Specified by:

getParameter in class HDBModelEvent

Throws:

de.innovationgate.webgate.api.WGAPIException

getMoveTargetContent

public de.innovationgate.webgate.api.WGContent getMoveTargetContent()

Description copied from class: HDBModelEvent

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

Specified by:

getMoveTargetContent in class HDBModelEvent

getType

public java.lang.String getType()

Description copied from class: HDBModelEvent

The HDBModel event type. Equals constants HDBModel.EVENT_*

Specified by:

getType in class HDBModelEvent

getContentClass

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

Description copied from class: HDBModelEvent

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)

Specified by:

getContentClass in class HDBModelEvent

Returns:

The content class

Throws:

de.innovationgate.webgate.api.WGAPIException

getDeletedContentKey

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

Description copied from class: HDBModelEvent

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

Specified by:

getDeletedContentKey in class HDBModelEvent

Throws:

de.innovationgate.webgate.api.WGAPIException