com.jaxfront.core.rule
Interface Rule

All Known Implementing Classes:

RuleImpl, SimpleRuleImpl

public interface Rule

Field Summary

static long	ABOUT_GO_NEXT
static long	ABOUT_GO_PREVIOUS
static long	ABOUT_TO_PERSIST
static long	ABOUT_TO_SERIALIZE
static long	ABOUT_TO_VALIDATE
static long	CHANGE Indicates if this rule is of type change.
static long	CHANGE_AND_INITIALIZATION Indicates if this rule is of type change & initialization.
static long	COPYCONTENT
static long	DOM_DELETED
static long	DOM_INITIALIZED
static long	GO_NEXT
static long	GO_PREVIOUS
static long	LIST_ITEM_DESELECTED
static long	LIST_ITEM_SELECTED
static long	NONE
static long	ONCREATE Indicates if this rule is of type on creation time of visualizer.
static long	PAGE_SELECTED
static long	PASTECONTENT
static long	PERSISTENT
static long	PROPERTYCHANGE Indicates if this rule is of type property change.
static long	SAVEDOCUMENT Indicates if this rule is of type save document.
static long	STRUCTURE_CHANGE Indicates if this rule is of type structure change.
static long	STRUCTURE_CHANGE_ADD Indicates if this rule is of type structure change (add).
static long	STRUCTURE_CHANGE_REMOVE Indicates if this rule is of type structure change (remove).
static long	TYPE_COMMIT
static long	VISUALIZED Indicates if this rule is of type initializisation.

Method Summary

void	apply(Type eventSource, java.lang.Object event) Applies ECA behaviour for the given sourceType
void	apply(Type eventSource, java.lang.Object event, boolean isRunningAsServer) Applies ECA behaviour for the given sourceType.
void	apply(Type eventSource, java.lang.Object event, boolean isRunningAsServer, java.util.Stack callStack)
java.lang.Object	clone(Type newSource)
boolean	doesConcern(Type sourceType) Indicates if the passing type does concern this rule.
java.util.List	getActions() Returns the actions for this rule.
ConditionExpression	getCondition() Returns the defined condition for this rule.
long	getCreationId()
java.lang.String	getId()
int	getPriority()
long	getRuleType() Return the rule type.
Type	getSource() Returns the source of this E-C-A rule.
boolean	isAboutGoNext()
boolean	isAboutGoPrevious()
boolean	isAboutToPersistRule() Indicates if this rule is of type on persistent.
boolean	isAboutToSerialize()
boolean	isAboutToValidateRule() Indicates if this rule is about to validate.
boolean	isChangeAndInitializationRule() Indicates if this rule is of type change & initialization.
boolean	isChangeRule() Indicates if this rule is of type change.
boolean	isCopyContentRule() Indicates if this rule is of type on copyContent.
boolean	isDomDeletedRule()
boolean	isDomInitialized()
boolean	isGoNext()
boolean	isGoPrevious()
boolean	isListItemDeselectedRule() Indicates if this rule is of type listtypedeselected.
boolean	isListItemSelectedRule() Indicates if this rule is of type listtypeselected.
boolean	isOnCreationRule() Indicates if this rule is of type on creation.
boolean	isPageSelected()
boolean	isPasteContentRule() Indicates if this rule is of type on creation.
boolean	isPersistentRule() Indicates if this rule is of type on persistent.
boolean	isPropertyChangeRule() Indicates if this rule is of type property change.
boolean	isReleased()
boolean	isSaveDocumentRule() Indicates if this rule is of type save document.
boolean	isScopeIncludeActionTarget()
boolean	isStructureChangeAddRule() Indicates if this rule is of type structure change (add).
boolean	isStructureChangeRemoveRule() Indicates if this rule is of type structure change (remove).
boolean	isStructureChangeRule() Indicates if this rule is of type structure change.
boolean	isTypeCommit()
boolean	isVisualizerInitializationRule() Indicates if this rule is of type initializisation.
void	release() Release all allocated resources for this rule.
long	removeRuleType(long removeType)
void	setCondition(ConditionExpression condition) Sets the condition of this rule.
void	setPriority(int priority) Sets the priority of this rule.

Field Detail

ABOUT_GO_NEXT

static final long ABOUT_GO_NEXT

See Also:

Constant Field Values

ABOUT_GO_PREVIOUS

static final long ABOUT_GO_PREVIOUS

See Also:

Constant Field Values

ABOUT_TO_PERSIST

static final long ABOUT_TO_PERSIST

See Also:

Constant Field Values

ABOUT_TO_SERIALIZE

static final long ABOUT_TO_SERIALIZE

See Also:

Constant Field Values

ABOUT_TO_VALIDATE

static final long ABOUT_TO_VALIDATE

See Also:

Constant Field Values

CHANGE

static final long CHANGE

Indicates if this rule is of type change.

See Also:

Constant Field Values

CHANGE_AND_INITIALIZATION

static final long CHANGE_AND_INITIALIZATION

Indicates if this rule is of type change & initialization.

See Also:

Constant Field Values

COPYCONTENT

static final long COPYCONTENT

See Also:

Constant Field Values

DOM_DELETED

static final long DOM_DELETED

See Also:

Constant Field Values

DOM_INITIALIZED

static final long DOM_INITIALIZED

See Also:

Constant Field Values

GO_NEXT

static final long GO_NEXT

See Also:

Constant Field Values

GO_PREVIOUS

static final long GO_PREVIOUS

See Also:

Constant Field Values

LIST_ITEM_DESELECTED

static final long LIST_ITEM_DESELECTED

See Also:

Constant Field Values

LIST_ITEM_SELECTED

static final long LIST_ITEM_SELECTED

See Also:

Constant Field Values

NONE

static final long NONE

See Also:

Constant Field Values

ONCREATE

static final long ONCREATE

Indicates if this rule is of type on creation time of visualizer.

See Also:

Constant Field Values

PAGE_SELECTED

static final long PAGE_SELECTED

See Also:

Constant Field Values

PASTECONTENT

static final long PASTECONTENT

See Also:

Constant Field Values

PERSISTENT

static final long PERSISTENT

See Also:

Constant Field Values

PROPERTYCHANGE

static final long PROPERTYCHANGE

Indicates if this rule is of type property change.

See Also:

Constant Field Values

SAVEDOCUMENT

static final long SAVEDOCUMENT

Indicates if this rule is of type save document.

See Also:

Constant Field Values

STRUCTURE_CHANGE

static final long STRUCTURE_CHANGE

Indicates if this rule is of type structure change.

See Also:

Constant Field Values

STRUCTURE_CHANGE_ADD

static final long STRUCTURE_CHANGE_ADD

Indicates if this rule is of type structure change (add).

See Also:

Constant Field Values

STRUCTURE_CHANGE_REMOVE

static final long STRUCTURE_CHANGE_REMOVE

Indicates if this rule is of type structure change (remove).

See Also:

Constant Field Values

TYPE_COMMIT

static final long TYPE_COMMIT

See Also:

Constant Field Values

VISUALIZED

static final long VISUALIZED

Indicates if this rule is of type initializisation.

See Also:

Constant Field Values

Method Detail

apply

void apply(Type eventSource,
           java.lang.Object event)

Applies ECA behaviour for the given sourceType

Parameters:

event - TODO

apply

void apply(Type eventSource,
           java.lang.Object event,
           boolean isRunningAsServer)

Applies ECA behaviour for the given sourceType. In some circumstances its necessary to apply the rule as temporary (e.g. if a component is displayed as dialog and not committed yet)

Parameters:

event - TODO

isRunningAsServer - defines if this rule should be applied in server mode

apply

void apply(Type eventSource,
           java.lang.Object event,
           boolean isRunningAsServer,
           java.util.Stack callStack)

clone

java.lang.Object clone(Type newSource)

doesConcern

boolean doesConcern(Type sourceType)

Indicates if the passing type does concern this rule.

Parameters:

sourceType - source of an occured change

indicates - if the change was a simple property change

getActions

java.util.List getActions()

Returns the actions for this rule.

getCondition

ConditionExpression getCondition()

Returns the defined condition for this rule.

getCreationId

long getCreationId()

getId

java.lang.String getId()

getPriority

int getPriority()

getRuleType

long getRuleType()

Return the rule type.

getSource

Type getSource()

Returns the source of this E-C-A rule.

isAboutGoNext

boolean isAboutGoNext()

isAboutGoPrevious

boolean isAboutGoPrevious()

isAboutToPersistRule

boolean isAboutToPersistRule()

Indicates if this rule is of type on persistent.

isAboutToSerialize

boolean isAboutToSerialize()

isAboutToValidateRule

boolean isAboutToValidateRule()

Indicates if this rule is about to validate.

isChangeAndInitializationRule

boolean isChangeAndInitializationRule()

Indicates if this rule is of type change & initialization.

isChangeRule

boolean isChangeRule()

Indicates if this rule is of type change.

isCopyContentRule

boolean isCopyContentRule()

Indicates if this rule is of type on copyContent.

isDomDeletedRule

boolean isDomDeletedRule()

isDomInitialized

boolean isDomInitialized()

isGoNext

boolean isGoNext()

isGoPrevious

boolean isGoPrevious()

isListItemDeselectedRule

boolean isListItemDeselectedRule()

Indicates if this rule is of type listtypedeselected.

isListItemSelectedRule

boolean isListItemSelectedRule()

Indicates if this rule is of type listtypeselected.

isOnCreationRule

boolean isOnCreationRule()

Indicates if this rule is of type on creation.

isPageSelected

boolean isPageSelected()

isPasteContentRule

boolean isPasteContentRule()

Indicates if this rule is of type on creation.

isPersistentRule

boolean isPersistentRule()

Indicates if this rule is of type on persistent.

isPropertyChangeRule

boolean isPropertyChangeRule()

Indicates if this rule is of type property change.

isReleased

boolean isReleased()

isSaveDocumentRule

boolean isSaveDocumentRule()

Indicates if this rule is of type save document.

isScopeIncludeActionTarget

boolean isScopeIncludeActionTarget()

isStructureChangeAddRule

boolean isStructureChangeAddRule()

Indicates if this rule is of type structure change (add).

isStructureChangeRemoveRule

boolean isStructureChangeRemoveRule()

Indicates if this rule is of type structure change (remove).

isStructureChangeRule

boolean isStructureChangeRule()

Indicates if this rule is of type structure change.

isTypeCommit

boolean isTypeCommit()

isVisualizerInitializationRule

boolean isVisualizerInitializationRule()

Indicates if this rule is of type initializisation.

release

void release()

Release all allocated resources for this rule.

removeRuleType

long removeRuleType(long removeType)

setCondition

void setCondition(ConditionExpression condition)

Sets the condition of this rule.

Parameters:

condition - condition for this rule

setPriority

void setPriority(int priority)

Sets the priority of this rule.

Parameters:

priority -