de.innovationgate.wgpublisher.hdb
public abstract class HDBModelEvent extends Object
Constructor and Description |
---|
HDBModelEvent() |
Modifier and Type | Method and Description |
---|---|
abstract void |
cancel(String message)
Cancels the event
|
abstract void |
cancel(String message,
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 String |
getContentClass()
The content class of the content that triggered the event execution, i.e. on which the event happened.
|
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 String |
getType()
The HDBModel event type.
|
void |
setCustomParam(Object customParam)
Sets a custom parameter object to the event.
|
public abstract void cancel(String message, Throwable throwable) throws Exception
message
- The cancelling messagethrowable
- A causing exceptionException
public abstract void cancel(String message) throws Exception
message
- The cancelling messageException
public abstract de.innovationgate.webgate.api.WGContent getEventReceiver() throws de.innovationgate.webgate.api.WGAPIException
de.innovationgate.webgate.api.WGAPIException
public abstract de.innovationgate.webgate.api.WGContent getContent() throws de.innovationgate.webgate.api.WGAPIException
de.innovationgate.webgate.api.WGAPIException
public abstract String getContentClass() throws de.innovationgate.webgate.api.WGAPIException
de.innovationgate.webgate.api.WGAPIException
public abstract de.innovationgate.webgate.api.WGHierarchicalDatabase getDb() throws de.innovationgate.webgate.api.WGAPIException
de.innovationgate.webgate.api.WGAPIException
public abstract HDBModelParams getParameter() throws de.innovationgate.webgate.api.WGAPIException
de.innovationgate.webgate.api.WGAPIException
public abstract de.innovationgate.webgate.api.WGContent getMoveTargetContent() throws de.innovationgate.webgate.api.WGAPIException
de.innovationgate.webgate.api.WGAPIException
public abstract String getType()
public Form getForm() throws de.innovationgate.webgate.api.WGAPIException
de.innovationgate.webgate.api.WGAPIException
public Object getCustomParam() throws de.innovationgate.webgate.api.WGAPIException
de.innovationgate.webgate.api.WGAPIException
public void setCustomParam(Object customParam) throws de.innovationgate.webgate.api.WGAPIException
getCustomParam()
.de.innovationgate.webgate.api.WGAPIException
public abstract de.innovationgate.webgate.api.WGContentKey getDeletedContentKey() throws de.innovationgate.webgate.api.WGAPIException
de.innovationgate.webgate.api.WGAPIException