Package com.solibri.smc.api.checking

Interface ResultCategory

public interface ResultCategory
This interface defines a result category. This can be created through the ResultFactory interface.
Since:
9.10.2

  • Method Details

    • getUniqueName

      String getUniqueName()
      Returns the unique name that identifies the category.
      Returns:
      the unique name
      Since:
      9.10.2

    • getDisplayName

      String getDisplayName()
      Returns the display name for the category.
      Returns:
      the display name
      Since:
      9.10.2

    • getParentCategory

      Optional<ResultCategory> getParentCategory()
      Returns the parent result category of this result category if such exists. If no parent category exists, this is a root category.
      Returns:
      the parent category
      Since:
      9.10.8

    • getChildCategories

      Set<ResultCategory> getChildCategories()
      Returns the categories for which this category is the parent. The returned Set cannot be modified.
      Returns:
      the set of child categories
      Since:
      9.10.8

    • getSlide

      Optional<Slide> getSlide()
      Returns the Slide related to this result category, if one exists.
      Returns:
      the related slide
      Since:
      9.12.0

    • setSlide

      Optional<Slide> setSlide​(Slide slide)
      Sets the related Slide for this result category and returns the possible previous related slide.
      Parameters:
      slide - the new slide
      Returns:
      the previous related slide
      Since:
      9.12.0

    • getDecision

      Decision getDecision()
      Returns the Decision of this result category If any result in this ResultCategory is UNDEFINED, then UNDEFINED is returned. If all the results are ACCEPTED, then ACCEPTED is returned. If none is UNDEFINED, and one or more is REJECTED, then REJECTED is returned.
      Returns:
      the decision of the ResultCategory
      Since:
      9.12.3

    • setDecision

      void setDecision​(Decision decision)
      Sets the Decision for all results in this ResultCategory.
      Parameters:
      decision - the new decision
      Since:
      9.12.3

    • getResults

      Set<Result> getResults()
      Returns all the results directly under this category. Does not return results from child categories.
      Returns:
      the results directly in this category
      Since:
      9.12.0

    • getAllResults

      Set<Result> getAllResults()
      Returns all the results directly under this category or any child categories of any degree of nesting.
      Returns:
      the results under this category
      Since:
      9.12.0