Package com.solibri.smc.api.checking

Interface Checking

public interface Checking

Checking provides access to information related to checking activities, such as whether checking has been done, and what the results are.

Since:

9.10.6

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	Checking.State	Describes the state of the checking.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	INTERRUPTION_IN_CHECKING	Error message for CheckingInterruptedException.
static final String	NO_PROJECT_IS_OPENED_TO_RUN_CHECKING	Error message for ProjectNotOpenException.

Method Summary

Modifier and Type	Method	Description
Set<Component>	getCheckedComponents(Rule rule)	Returns the components that have been checked with a given Rule.
Set<Component>	getFailedComponents(Rule rule)	Returns the components that have checked with a given Rule and have failed the checking.
Set<Component>	getFailedComponents(Rule rule, Decision decision, Severity severity)	Returns the components that have been checked with a given Rule and have a specific Decision and Severity.
Set<Component>	getPassedComponents(Rule rule)	Returns the components that have checked with a given Rule and have passed the checking.
Collection<Result>	getResults()	Returns results of the checking.
Collection<Result>	getResults(Rule rule)	Returns results of the checking for a given Rule.
Checking.State	getState()	Returns the state of the checking.
Collection<Result>	runChecking(boolean checkSelected)	Runs checking and returns the checking results.

Field Details

INTERRUPTION_IN_CHECKING

static final String INTERRUPTION_IN_CHECKING

Error message for CheckingInterruptedException.

Since:

9.12.7

See Also:

• Constant Field Values

NO_PROJECT_IS_OPENED_TO_RUN_CHECKING

static final String NO_PROJECT_IS_OPENED_TO_RUN_CHECKING

Error message for ProjectNotOpenException.

Since:

9.12.7

See Also:

• Constant Field Values

Method Details

getState

Checking.State getState()

Returns the state of the checking.

Returns:

the state

Since:

9.10.6

getResults

Collection<Result> getResults()

Returns results of the checking. When checking is ongoing, the results returned might be empty. If you want to get results for a currently running rule, use getResults(Rule) instead.

Returns:

results of the checking

Since:

9.10.6

getCheckedComponents

Set<Component> getCheckedComponents(Rule rule)

Returns the components that have been checked with a given Rule.

Parameters:

rule - the rule for where to get the checked components

Returns:

the components that have been checked with a given rule

Since:

24.12.0

getPassedComponents

Set<Component> getPassedComponents(Rule rule)

Returns the components that have checked with a given Rule and have passed the checking.

Parameters:

rule - the rule for where to get the passed components

Returns:

the components that have passed the checking with a given rule

Since:

24.12.0

getFailedComponents

Set<Component> getFailedComponents(Rule rule)

Returns the components that have checked with a given Rule and have failed the checking.

Parameters:

rule - the rule for where to get the failed components

Returns:

the components that have failed the checking of a given rule

Since:

24.12.0

getFailedComponents

Set<Component> getFailedComponents(Rule rule,
 Decision decision,
 Severity severity)

Returns the components that have been checked with a given Rule and have a specific Decision and Severity.

Parameters:

rule - the rule for where to get the failed components

decision - the decision to filter the components or null to get components with any decision

severity - the severity to filter the components or null to get components with any severity

Returns:

the components that have been checked with a given rule and have a specific decision

Since:

24.12.0

getResults

Collection<Result> getResults(Rule rule)

Returns results of the checking for a given Rule.

Parameters:

rule - the rule for which to get results

Returns:

results of the checking for a given rule

Since:

9.12.0

runChecking

Collection<Result> runChecking(boolean checkSelected)
                        throws ProjectNotOpenException,
CheckingInterruptedException

Runs checking and returns the checking results.

Parameters:

checkSelected - Runs checking in selected mode if true else runs normal checking

Returns:

Collection of checking results

Throws:

ProjectNotOpenException - Project not opened exception

CheckingInterruptedException - Interruption during checking

Since:

9.12.7