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 SummaryNested ClassesModifier and TypeInterfaceDescriptionstatic enumDescribes the state of the checking.
- 
Field SummaryFieldsModifier and TypeFieldDescriptionstatic final StringError message forCheckingInterruptedException.static final StringError message forProjectNotOpenException.
- 
Method SummaryModifier and TypeMethodDescriptionReturns results of the checking.getResults(Rule rule) Returns results of the checking for a givenRule.getState()Returns the state of the checking.runChecking(boolean checkSelected) Runs checking and returns the checking results.
- 
Field Details- 
INTERRUPTION_IN_CHECKINGError message forCheckingInterruptedException.- Since:
- 9.12.7
- See Also:
 
- 
NO_PROJECT_IS_OPENED_TO_RUN_CHECKINGError message forProjectNotOpenException.- Since:
- 9.12.7
- See Also:
 
 
- 
- 
Method Details- 
getStateChecking.State getState()Returns the state of the checking.- Returns:
- the state
- Since:
- 9.10.6
 
- 
getResultsCollection<Result> getResults()Returns results of the checking. When checking is ongoing, the results returned might be empty.- Returns:
- results of the checking
- Since:
- 9.10.6
 
- 
getResultsReturns results of the checking for a givenRule. When checking is ongoing, the results returned might be empty.- Parameters:
- rule- the rule for which to get results
- Returns:
- results of the checking for a given rule
- Since:
- 9.12.0
 
- 
runCheckingCollection<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
 
 
-