LEONARDI Application Composer - 8.9.0.40 by W4 S.A.

leon.info
Class LyRule

java.lang.Object
  extended by leon.info.LyTag
      extended by leon.info.LyInfo
          extended by leon.info.LyRule
All Implemented Interfaces:
java.lang.Cloneable, LyCommentInterface

public final class LyRule
extends LyInfo

This class implements a rule triggered upon choice option modification. Rules are attached to choice options and are triggered when options are checked ou unchecked. They define an operation to perform on a fieldInfo located in the same edition view (creation or modification form). This class extends LyInfo : this means that rules can be identified within an application.
A rule contains extra attributes :

See Also:
LyChoiceOption, LyChoiceFieldInfo

Nested Class Summary
static class LyRule.Operation
          Operations.
 
Nested classes/interfaces inherited from class leon.info.LyTag
LyTag.Model
 
Field Summary
static java.lang.String __VERSION
           
 
Method Summary
 LyFieldInfo getFieldInfo()
          Deprecated. Use getObjectInfo instead.
 LyFilter getFilter()
          Accessor for the filter that triggers this rule.
 java.lang.String getFormula()
          Gets the formula (as a string) associated to this number field.
 java.lang.Object getInitValue()
          Accessor of the value used by this rule on SET_VALUE operation.
 LyInfoLabel getLabel()
          Accessor of the label used by this rule on SET_LABEL operation.
 LyFormula getLyFormula()
          Gets the formula associated to this control.
 LyObjectInfo getObjectInfo()
          Accessor of the fieldInfo impacted by this rule.
 LyRule.Operation getOperation()
          Gets the operation done on this rule.
 int getPriority()
          Gets priority of the rule.
 java.lang.String getStringValue()
          Accessor of the value used by this rule on SET_VALUE operation.
 java.lang.Object getValue()
          Accessor of the value used by this rule on SET_VALUE operation.
 boolean isOnCheck()
          Specifies if the rule is triggered when checking or on unchecking the associated option.
 
Methods inherited from class leon.info.LyInfo
getAlias, getApplication, getFile, getId, getInclude, getName, isIncluded, isInternal, isInternal, isLoaded, isLocked, load, setApplication, setFile, toString
 
Methods inherited from class leon.info.LyTag
clone, getCommentsEnd, getCommentsStart, getEnvironment, getModelType, getParent, getRootProject, hasAncestor, isExtern, setCommentsEnd, setCommentsStart, wasCloned
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface leon.parser.LyCommentInterface
getCommentsEnd, getCommentsStart, setCommentsEnd, setCommentsStart
 

Field Detail

__VERSION

public static final java.lang.String __VERSION
See Also:
Constant Field Values
Method Detail

getFieldInfo

public LyFieldInfo getFieldInfo()
Deprecated. Use getObjectInfo instead.

Accessor of the fieldInfo impacted by this rule.

Returns:
The fieldInfo concerned by this rule (may be null).

getObjectInfo

public LyObjectInfo getObjectInfo()
Accessor of the fieldInfo impacted by this rule.

Returns:
The fieldInfo concerned by this rule.

getPriority

public int getPriority()
Gets priority of the rule.


getOperation

public LyRule.Operation getOperation()
Gets the operation done on this rule.

Returns:
Operation defined for this rule.

isOnCheck

public boolean isOnCheck()
Specifies if the rule is triggered when checking or on unchecking the associated option.

Returns:
True if set, false if unset.

getValue

public java.lang.Object getValue()
Accessor of the value used by this rule on SET_VALUE operation.

Returns:
The value used by this rule on SET_VALUE operation.

getInitValue

public final java.lang.Object getInitValue()
Accessor of the value used by this rule on SET_VALUE operation.

Returns:
The value used by this rule on SET_VALUE operation.

getStringValue

public java.lang.String getStringValue()
Accessor of the value used by this rule on SET_VALUE operation.

Returns:
The value used by this rule on SET_VALUE operation.

getFilter

public LyFilter getFilter()
Accessor for the filter that triggers this rule.


getLabel

public LyInfoLabel getLabel()
Accessor of the label used by this rule on SET_LABEL operation.

Returns:
The label used by this rule on SET_LABEL operation.

getFormula

public java.lang.String getFormula()
Gets the formula (as a string) associated to this number field. The formula is provided to calculate values of this field thanks to a simple mathematic expression using other numerc fields in the same application class.

Returns:
Current formula or null if no formula is set.

getLyFormula

public final LyFormula getLyFormula()
Gets the formula associated to this control.

Returns:
Current formula or null if no formula is set.

(c) January 2013 - W4 S.A.

Website: W4 S.A., contact us: support@w4global.com