Package com.e1c.g5.v8.dt.check.ext
Interface ITopObjectFilter
-
- All Known Implementing Classes:
BasicCheck
,DocumentationCommentBasicDelegateCheck
,QlBasicDelegateCheck
- Functional Interface:
- This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.
@FunctionalInterface public interface ITopObjectFilter
ICheck
API extension that allows to filter out non-applicable top objects (e.g. having improper name) during the check. This allows to build effective checks of contained objects without constant re-checking of the containment's parent hierarchy for each containment.
In order to use the filter the check should implement this interface
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description boolean
isCheckApplicable(IBmObject topObject, ICheckParameters parameters)
Checks if the given top object is a potential target of the current check.
-
-
-
Method Detail
-
isCheckApplicable
boolean isCheckApplicable(IBmObject topObject, ICheckParameters parameters)
Checks if the given top object is a potential target of the current check. This method is being called by the check engine during the validation cycle, effectively preventing the check from execution in case of false decision- Parameters:
topObject
- The top object to check. May not benull
parameters
- The set of the check parameter. May not benull
- Returns:
- True if the top object is potential target for the check. False overwise.
-
-