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

Interface ICheckScheduler

All Superinterfaces:
IManagedService
All Known Implementing Classes:
CheckScheduler
public interface ICheckScheduler extends IManagedService
This service allows to schedule checks for the provided set of features and target objects Checks are being executed by ACC subsystem in asynchronous manner, with results immediatelly available on finihish of the schedule check

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    SERVICE_NAME
     

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    isDeactivatedCheckPermitted(Object objectId, org.eclipse.core.resources.IProject project)
    States if there is an explicit permission was given earlier to perform checks for a provided object.
    void
    permitDeactivatedCheckRequest(Object objectId, org.eclipse.core.resources.IProject project)
    Permits next request to check for a specific object even if massive checks are deactivated for a specified project.
    void
    scheduleClearance(org.eclipse.core.resources.IProject project, Set<String> checkIds, org.eclipse.core.runtime.IProgressMonitor progressMonitor)
    Schedules the clearance of the check results for the given set of checks
    void
    scheduleValidation(org.eclipse.core.resources.IProject project, Set<String> checkIds, Collection<Object> topObjectIds, boolean isRecursive, IBmTransaction transaction, org.eclipse.core.runtime.IProgressMonitor progressMonitor)
    Schedules the model object validation for objects with given object ids by suitable checks with the given check ids.
    default void
    scheduleValidation(org.eclipse.core.resources.IProject project, Set<String> checkIds, Collection<Object> topObjectIds, IBmTransaction transaction, org.eclipse.core.runtime.IProgressMonitor progressMonitor)
    Schedules the model object validation for objects with given object ids by suitable checks with the given check ids.
    void
    scheduleValidation(org.eclipse.core.resources.IProject project, Set<String> checkIds, Collection<Object> topObjectIds, org.eclipse.core.runtime.IProgressMonitor progressMonitor)
    Schedules the model object validation for objects with given object ids by suitable checks with the given check ids.

    Methods inherited from interface com._1c.g5.wiring.IManagedService

    activate, deactivate

  • Field Details

  • Method Details

    • scheduleClearance

      void scheduleClearance(org.eclipse.core.resources.IProject project, Set<String> checkIds, org.eclipse.core.runtime.IProgressMonitor progressMonitor)
      Schedules the clearance of the check results for the given set of checks
      Parameters:
      project - Target project, not null
      checkIds - The set of target check identifeirs. If empty set is applied - all applicable checks will be cleared, not null
      progressMonitor - progress monitor, not null

    • scheduleValidation

      default void scheduleValidation(org.eclipse.core.resources.IProject project, Set<String> checkIds, Collection<Object> topObjectIds, IBmTransaction transaction, org.eclipse.core.runtime.IProgressMonitor progressMonitor)
      Schedules the model object validation for objects with given object ids by suitable checks with the given check ids. It will probably be executed asynchronously. It can be canceled using the progress monitor.
      Parameters:
      project - Target project, not null
      checkIds - The set of target check identifeirs. If empty set is applied - all applicable checks will be scheduled, not null
      topObjectIds - Identifiers of checked objects, all available objects if left empty, not null
      transaction - The active read-only transaction to perform the scheduling of checks (e.g. context collection)
      progressMonitor - progress monitor, not null

    • scheduleValidation

      void scheduleValidation(org.eclipse.core.resources.IProject project, Set<String> checkIds, Collection<Object> topObjectIds, boolean isRecursive, IBmTransaction transaction, org.eclipse.core.runtime.IProgressMonitor progressMonitor)
      Schedules the model object validation for objects with given object ids by suitable checks with the given check ids. It will probably be executed asynchronously. It can be canceled using the progress monitor.
      Parameters:
      project - Target project, not null
      checkIds - The set of target check identifeirs. If empty set is applied - all applicable checks will be scheduled, not null
      topObjectIds - Identifiers of checked objects, all available objects if left empty, not null
      isRecursive - if true all the dependencies (including modules) of objects provided by topObjectIds are processed. If false then it's supposed that all required objects are passed via topObjectIds
      transaction - The active read-only transaction to perform the scheduling of checks (e.g. context collection)
      progressMonitor - progress monitor, not null

    • scheduleValidation

      void scheduleValidation(org.eclipse.core.resources.IProject project, Set<String> checkIds, Collection<Object> topObjectIds, org.eclipse.core.runtime.IProgressMonitor progressMonitor)
      Schedules the model object validation for objects with given object ids by suitable checks with the given check ids. It will probably be executed asynchronously. It can be canceled using the progress monitor.
      Parameters:
      project - Target project, not null
      checkIds - The set of target check identifeirs. If empty set is applied - all applicable checks will be scheduled, not null
      topObjectIds - Identifiers of checked objects, all available objects if left empty, not null
      progressMonitor - progress monitor, not null

    • permitDeactivatedCheckRequest

      void permitDeactivatedCheckRequest(Object objectId, org.eclipse.core.resources.IProject project)
      Permits next request to check for a specific object even if massive checks are deactivated for a specified project. This method allows active editors to perform limited number of checks independenly of the mode
      Parameters:
      objectId - Target object identifier. Accepts both resource URI's and BM object ids
      project - Target project, not null

    • isDeactivatedCheckPermitted

      boolean isDeactivatedCheckPermitted(Object objectId, org.eclipse.core.resources.IProject project)
      States if there is an explicit permission was given earlier to perform checks for a provided object. The permission is retracted after a check so it is a single-time permission effectively
      Parameters:
      objectId - The object to check permission for. Cannot be null. Must be compliant with ICheckScheduler#permitDeactivatedCheckRequest(IProject, Object) requirements
      project - Target project, not null
      Returns:
      True if a permission was given earlier