org.nuclos.api.context

Interface GenerateContext

All Superinterfaces:

LogContext, RuleContext

public interface GenerateContext
extends RuleContext

GenerateContext represents the context used in Generation-Rule

It contains the TargetObjects and the SourceObjects and several functions like caching

Author:

Matthias Reichart

See Also:

RuleContext

Method Summary

Modifier and Type	Method and Description
<T extends GenericBusinessObject> T	getParameterGenericObject(java.lang.Class<T> t) This method returns a GenericBusinessObject that represent the Parameter
BusinessObject	getParameterObject() This method returns the ParameterObject
<T extends GenericBusinessObject> T	getSourceGenericObject(java.lang.Class<T> t) This method returns the GenericBusinessObject that represents the source; if there is more than one SourceObject a BusinessException will be thrown; In this case use getSourceObjects(Class<T> t) instead
<T extends GenericBusinessObject> java.util.Collection<T>	getSourceGenericObjects(java.lang.Class<T> t) This method returns a list of GenericBusinessObjects that represent the Sources
<T extends BusinessObject> T	getSourceObject(java.lang.Class<T> t) This method returns a BusinessObject that represents the source; if there is more than one SourceObject a BusinessException will be thrown; In this case use getSourceObjects(Class<T> t) instead
<T extends BusinessObject> java.util.Collection<T>	getSourceObjects(java.lang.Class<T> t) This method returns a list of BusinessObject that represent the Sources
<T extends GenericBusinessObject> T	getTargetGenericObject(java.lang.Class<T> t) This method returns a GenericBusinessObject that represent the Target
<T extends BusinessObject> T	getTargetObject(java.lang.Class<T> t) This method returns a BusinessObject that represent the Target
void	notify(java.lang.String message, BusinessObject source) Creates a message with a Priority.
void	notify(java.lang.String message, Priority prio, BusinessObject source) Creates a message with a Priority.

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

getSourceObject

<T extends BusinessObject> T getSourceObject(java.lang.Class<T> t)
                                      throws BusinessException

This method returns a BusinessObject that represents the source; if there is more than one SourceObject a BusinessException will be thrown; In this case use getSourceObjects(Class<T> t) instead

Throws:

BusinessException

getSourceObjects

<T extends BusinessObject> java.util.Collection<T> getSourceObjects(java.lang.Class<T> t)

This method returns a list of BusinessObject that represent the Sources

getTargetObject

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

This method returns a BusinessObject that represent the Target

getParameterObject

BusinessObject getParameterObject()

This method returns the ParameterObject

getSourceGenericObject

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

This method returns the GenericBusinessObject that represents the source; if there is more than one SourceObject a BusinessException will be thrown; In this case use getSourceObjects(Class<T> t) instead

Throws:

BusinessException

getSourceGenericObjects

<T extends GenericBusinessObject> java.util.Collection<T> getSourceGenericObjects(java.lang.Class<T> t)
                                                                           throws BusinessException

This method returns a list of GenericBusinessObjects that represent the Sources

Throws:

BusinessException

getTargetGenericObject

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

This method returns a GenericBusinessObject that represent the Target

Throws:

BusinessException

getParameterGenericObject

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

This method returns a GenericBusinessObject that represent the Parameter

Throws:

BusinessException

notify

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

Creates a message with a Priority. The message is displayed in the notification dialog in nuclos. The target of the current generation is stored inside the context. The source must be set by the user. Please check class Priority to get more information about the priority-handling.

notify

void notify(java.lang.String message,
            BusinessObject source)

Creates a message with a Priority. The message is displayed in the notification dialog in nuclos as a message with priority 'normal'. The target of the current generation is stored inside the context. The source must be set by the user.