LEONARDI Application Composer - 8.9.0.40 by W4 S.A.

leon.app.behaviorinterface
Interface LyFilterBehaviorInterface

All Superinterfaces:
LyBehaviorInterface
All Known Subinterfaces:
LyClassBehaviorInterface
All Known Implementing Classes:
LyClassBehavior

public interface LyFilterBehaviorInterface
extends LyBehaviorInterface

This interface defines the methods to implement in order to modify the behavior of a filter controller.

See Also:
LyFilterController

Field Summary
static java.lang.String __VERSION
          File version
 
Method Summary
 LyFilterElement buildFilterElement(LyFilterController filter, LyFieldInfo fieldInfo, boolean not, LyFilterExpression.Condition condition, java.lang.Object value, java.util.BitSet modifiers)
          Builds a filter element with the given parameters.
 java.util.Vector<LyChoiceOption> getFilterChoiceDomain(LyFilterController filter, LyChoiceFieldInfo choice)
          Gets domain (list of allowed options) of the given choice fieldInfo.
 LyInfoList<LyClassInfo> getFilterRelationClasses(LyFormController filter, LyRelationFieldInfo relation)
          Gets the list of available class info for the given relation filtering.
 LyObjectList getFilterRelationDomain(LyFilterController filter, LyRelationFieldInfo relation)
          Gets relation domain (list of available links in the filter context) for the given relation fieldInfo for filter actions.
 LyInfoDataList<LyAction,LyClassInfo> getFilterTransverseActions(LyFilterController filter, LyFieldInfo fieldInfo)
          Gets all actions enabled by the given field for a filter action.
 LyInfoDataList<LyAction,LyClassInfo> getFilterTransverseActions(LyFilterController filter, LyRelationFieldInfo relation)
          Gets all actions enabled by the given relation for a filter action.
 
Methods inherited from interface leon.app.behaviorinterface.LyBehaviorInterface
free, handleDemand, init
 

Field Detail

__VERSION

static final java.lang.String __VERSION
File version

See Also:
Constant Field Values
Method Detail

getFilterRelationDomain

LyObjectList getFilterRelationDomain(LyFilterController filter,
                                     LyRelationFieldInfo relation)
Gets relation domain (list of available links in the filter context) for the given relation fieldInfo for filter actions.

Parameters:
filter - the current LyFilterController instance
relation - the target relation field
Returns:
a list of LyObjects available for this relation in filtering context.

getFilterRelationClasses

LyInfoList<LyClassInfo> getFilterRelationClasses(LyFormController filter,
                                                 LyRelationFieldInfo relation)
Gets the list of available class info for the given relation filtering.

Parameters:
filter - the current instance of "filter controller" This parameter could be both a LyFilterController or a LyFilterRelationController. That's why its type is LyFormController which is the common inheritance.
relation - the target relation field
Returns:
a list of classInfo available for filtering the relation

getFilterTransverseActions

LyInfoDataList<LyAction,LyClassInfo> getFilterTransverseActions(LyFilterController filter,
                                                                LyFieldInfo fieldInfo)
Gets all actions enabled by the given field for a filter action. A list of pairs (action, classInfo) has to be returned.

Parameters:
filter - the current LyFilterController instance
fieldInfo - the field that may enabled some actions
Returns:
a list of actions enabled by the given field for a filter action

getFilterTransverseActions

LyInfoDataList<LyAction,LyClassInfo> getFilterTransverseActions(LyFilterController filter,
                                                                LyRelationFieldInfo relation)
Gets all actions enabled by the given relation for a filter action. A list of pairs (action, classInfo) has to be returned.

Parameters:
filter - the current LyFilterController instance
relation - the relation that may enabled some actions
Returns:
a list of actions enabled by the given relation for a filter action

getFilterChoiceDomain

java.util.Vector<LyChoiceOption> getFilterChoiceDomain(LyFilterController filter,
                                                       LyChoiceFieldInfo choice)
Gets domain (list of allowed options) of the given choice fieldInfo.

Parameters:
filter - the current LyFilterController instance
choice - target choice fieldInfo
Returns:
a list of LyChoiceOption allowed for this choice field info

buildFilterElement

LyFilterElement buildFilterElement(LyFilterController filter,
                                   LyFieldInfo fieldInfo,
                                   boolean not,
                                   LyFilterExpression.Condition condition,
                                   java.lang.Object value,
                                   java.util.BitSet modifiers)
Builds a filter element with the given parameters.

Parameters:
filter - the current LyFilterController instance
fieldInfo - FieldInfo on which this filter expression applies.
not - Inverts filter condition or not.
condition - Filter condition.
value - Value of this expression (may be null). This value is an instance of the class returned by the getValueClass method of LyFieldInfo.
modifiers - List of modifiers (may be null).
Returns:
The corresponding filter element or null if nothing specific must be done

(c) January 2013 - W4 S.A.

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