org.nuclos.api.context

Interface CustomContext

All Superinterfaces:

LogContext, RuleContext

public interface CustomContext
extends RuleContext

CustomContext represents the context used in a Custom-Rule

It contains the BusinessObject to edit and several functions like caching

Author:

Matthias Reichart

See Also:

RuleContext

Method Summary

Modifier and Type	Method and Description
<T extends BusinessObject> T	getBusinessObject(java.lang.Class<T> t) This method returns the BusinessObject containing the entry-data.
<T extends GenericBusinessObject> T	getGenericBusinessObject(java.lang.Class<T> t) This method returns the GenericBusinessObject containing the entry-data to edit during runtime.
boolean	getUpdateAfterExecution() This method returns true if the BusinessObject of the context is updated after rule execution.
void	notify(java.lang.String message) Creates a message with normal Priority.
void	notify(java.lang.String message, Priority prio) Creates a message with a Priority.
void	setUpdateAfterExecution(boolean bUpdateAfterExecution) Sets flag "UpdateAfterExecution" to control if the BusinessObject of the context is updated after rule execution.

Methods inherited from interface org.nuclos.api.context.RuleContext

addContextCacheValue, getContextCacheValue, getLanguage, getUser, removeContextCacheValue

Methods inherited from interface org.nuclos.api.context.LogContext

log, logError, logWarn

Method Detail

getBusinessObject

<T extends BusinessObject> T getBusinessObject(java.lang.Class<T> t)

This method returns the BusinessObject containing the entry-data.

Parameters:

t - Classtype being a BusinessObject

Returns:

BusinessObject

getGenericBusinessObject

<T extends GenericBusinessObject> T getGenericBusinessObject(java.lang.Class<T> t)
                                                      throws BusinessException

This method returns the GenericBusinessObject containing the entry-data to edit during runtime.

Parameters:

t - Classtype being a GenericBusinessObject

Returns:

GenericBusinessObject extending GenericBusinessObject

Throws:

BusinessException

notify

void notify(java.lang.String message,
            Priority prio)

Creates a message with a Priority. The message is displayed in the notification dialog in nuclos. Please check class Priority to get more information about the priority-handling.

Parameters:

message -

prio -

notify

void notify(java.lang.String message)

Creates a message with normal Priority. It is displayed in the notification dialog in nuclos as a message. Please check class Priority to get more information about the priority-handling.

Parameters:

message -

setUpdateAfterExecution

void setUpdateAfterExecution(boolean bUpdateAfterExecution)

Sets flag "UpdateAfterExecution" to control if the BusinessObject of the context is updated after rule execution. "true" means: update after rule execution.

Parameters:

bUpdateAfterExecution -

getUpdateAfterExecution

boolean getUpdateAfterExecution()

This method returns true if the BusinessObject of the context is updated after rule execution.

Returns:

true or false