Package com.solibri.smc.api.checking
Interface CheckingSelection
-
public interface CheckingSelection
Allows components that have been previously selected usingComponentSelector
to be retrieved and marked as checked. Every component selected for checking must be marked as checked by the end of theRule.check(CheckingSelection, ResultFactory)
method execution. Can be used during pre check and check phases.- Since:
- 9.10.2
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
fail(Component component, Result result)
Mark a component as checked and register a failure described by the specifiedResult
.void
fail(Collection<? extends Component> components, Result result)
Mark the specified components as checked and register a failure described by the specifiedResult
.Set<Component>
getRemaining()
Get the components that have been selected for checking but are still not checked.boolean
isEmpty()
Returns true if this selection is empty.void
pass(Component component)
Mark a component as checked, without creating any failure.void
pass(Collection<? extends Component> components)
Mark the specified components as checked, without creating any failure.void
passRemaining()
Mark all the still unchecked components as checked, without creating any additional failure.
-
-
-
Method Detail
-
pass
void pass(Component component)
Mark a component as checked, without creating any failure.- Parameters:
component
- the checked component- Since:
- 9.10.2
-
pass
void pass(Collection<? extends Component> components)
Mark the specified components as checked, without creating any failure.- Parameters:
components
- the checked components- Since:
- 9.10.2
-
fail
void fail(Component component, Result result)
Mark a component as checked and register a failure described by the specifiedResult
.- Parameters:
component
- the checked componentresult
- the result that causes the component to fail- Since:
- 9.10.2
-
fail
void fail(Collection<? extends Component> components, Result result)
Mark the specified components as checked and register a failure described by the specifiedResult
.- Parameters:
components
- the checked componentsresult
- the result that causes the components to fail- Since:
- 9.10.2
-
passRemaining
void passRemaining()
Mark all the still unchecked components as checked, without creating any additional failure.- Since:
- 9.10.2
-
isEmpty
boolean isEmpty()
Returns true if this selection is empty.- Returns:
- true if this selection is empty
- Since:
- 9.10.2
-
-