Package com.e1c.g5.v8.dt.check

Interface ICheck<CT>

All Known Implementing Classes:
AbstractTestCheck, AdditionalIndexesCheck, BaseQlDelegatingCheck, BasicCheck, BinaryDataStorageLocationUseFieldTypeCheck, BslQlDelegatingCheck, ConfigurationStandaloneContentCheck, DbObjectTabularSectionCheck, DcsQlDelegatingCheck, DocumentationCommentBasicDelegateCheck, DocumentationCommentDelegatingCheck, FormLegacyEmfCheck, FormQlDelegatingCheck, LegacyCheckAdapter, MdLegacyEmfCheck, QlBasicDelegateCheck, ReferenceValueCheck, ReferenceValueCheckNonCritical, XdtoPackageExtensionPackageNamespaceFeaturesStateCheck
public interface ICheck<CT>
Low level check interface. Checks can be added through the extension point "com.e1c.g5.v8.dt.checks.check"

  • Method Details

    • check

      default void check(Object object, ICheckResultAcceptor resultRegistrar, ICheckParameters parameters, org.eclipse.core.runtime.IProgressMonitor progressMonitor)
      All checked objects must be registered in resultAcceptor. Each checked object should be in the result, regardless of whether there are any issues in it. Adding objects that do not have errors in result is necessary to clear issues that were not previously defined in the object. Validation may be cancelled by user. Complex implemantation should take this into account and checks IProgressMonitor.isCanceled() between long time operations.
      Parameters:
      object - the checking object, not null
      resultRegistrar - the result acceptor, not null
      parameters - check execution parameters from settings, not null
      progressMonitor - progress monitor, not null

    • check

      default void check(Object object, ICheckResultAcceptor resultRegistrar, ICheckParameters parameters, CT checkContext, org.eclipse.core.runtime.IProgressMonitor progressMonitor)
      All checked objects must be registered in resultAcceptor. Each checked object should be in the result, regardless of whether there are any issues in it. Adding objects that do not have errors in result is necessary to clear issues that were not previously defined in the object. Validation may be cancelled by user. Complex implemantation should take this into account and checks IProgressMonitor.isCanceled() between long time operations.
      Parameters:
      object - the checking object, not null
      resultRegistrar - the result acceptor, not null
      parameters - check execution parameters from settings, not null
      checkContext - the context of a check (if provided). May be null
      progressMonitor - progress monitor, not null

    • configureContextCollector

      void configureContextCollector(ICheckDefinition definition)
      The first phase of the check performing is the check context prepartion. The check should react to the system events and mark situations when the check launch is required. The CheckDefinition defines the logic of check context collection, see it for more details

    • getCheckId

      String getCheckId()
      Gets the unique identifier of the check. The identifier should be unique. The system performs automated identifier conflict resolution in case of non-unique identifiers, with addition of conflict-resolving symbols to the identifier
      Returns:
      The identifier of the check. May not be null

    • prepareContext

      @Deprecated default CT prepareContext(Object object, ICheckParameters parameters, org.eclipse.core.runtime.IProgressMonitor progressMonitor)
      Deprecated.
      Use prepareContext(Object, Map, ICheckParameters, IProgressMonitor) instead
      Prepares context of the check if applicable. Context may be used to provide commonly used data and facilities, as well as collect data during subsequent calls of the check on the same data subtree
      Parameters:
      object - The initial object for the check. Usually is a top BM object or top object in the resource. May not be null
      parameters - check execution parameters from settings, not null
      progressMonitor - progress monitor, not null
      Returns:
      Context if any. May be null

    • prepareContext

      default CT prepareContext(Object object, Map<String,String> additionalContext, ICheckParameters parameters, org.eclipse.core.runtime.IProgressMonitor progressMonitor)
      Prepares context of the check if applicable. Context may be used to provide commonly used data and facilities, as well as collect data during subsequent calls of the check on the same data subtree
      Parameters:
      object - The initial object for the check. Usually is a top BM object or top object in the resource. May not be null
      additionalContext - The additional context map which is being collected during the check context collecting phase. Cannot be null
      parameters - check execution parameters from settings, not null
      progressMonitor - progress monitor, not null
      Returns:
      Context if any. May be null