com.solibri.smc.api.checking

Interface Rule

All Known Implementing Classes:

OneByOneRule

public interface Rule

The interface for rules.

Since:

9.10.2

Method Summary

Modifier and Type	Method and Description
void	check(CheckingSelection components, ResultFactory resultFactory) Called to implement the check phase.
default UIContainer	getParametersUIDefinition() Returns the container that defines the UI for the parameters view of this rule.
default void	postCheck() This is called once after the checking of components.
PreCheckResult	preCheck(ComponentSelector components) This method is called once before the actual checking of the components.

Method Detail

preCheck

PreCheckResult preCheck(ComponentSelector components)

This method is called once before the actual checking of the components. The job of the pre check method is to select the components to be checked through the ComponentSelector parameter. Additionally, a PreCheckResult must be returned, reporting if the checking of this rule should continue to the next phase (with PreCheckResult.createRelevant()) or skipped (with PreCheckResult.createIrrelevant()). In both cases, a message can be added to document the result.

Parameters:

components - the CheckingSelection to mark components as checked

Returns:

a pre-check result

Since:

9.10.2

check

void check(CheckingSelection components,
           ResultFactory resultFactory)

Called to implement the check phase. All the components selected during the pre check phase must be reported as checked through the CheckingSelection instance received as parameter, during the check phase.

Parameters:

components - the CheckingSelection to mark components as checked

resultFactory - the result factory used to create results for this rule

Since:

9.10.2

postCheck

default void postCheck()

This is called once after the checking of components. Use cases: - post calculation for the checking - analysis of the results

Since:

9.10.2

getParametersUIDefinition

default UIContainer getParametersUIDefinition()

Returns the container that defines the UI for the parameters view of this rule.

Returns:

the container that defines the parameters view of this rule

Since:

9.10.2