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

Interface ISuppressSettingsManager

All Superinterfaces:

IManagedService

public interface ISuppressSettingsManager
extends IManagedService

Suppress settings manager is responsible for answering the question about check suppressions.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SERVICE_NAME

Method Summary

Modifier and Type	Method	Description
void	addListener(ISuppressSettingsChangeListener listener)	Adds the specified ISuppressSettingsChangeListener
void	addSuppression(IBmObject target, CheckUid checkUid)	Adds a suppression of the given check for a specified model object
Set<String>	excludeSuppressedCheckIds(org.eclipse.emf.ecore.EObject source, org.eclipse.core.resources.IProject project, Set<String> checkIds, IBslElementRegionProvider bslElementRegionProvider)	Excludes suppressed check ids from set of given check ids.
void	finishSuppressionSession(SuppressionSessionHandle handle)	Finalizes the suppression session
boolean	isSuppressed(Object object, String checkId, String checkContributor)	Answers to the question whether the particular check is suppressed for selected object.
SuppressionSessionHandle	prepareSuppressionSession()	Creates and registers a new suppression session
void	removeListener(ISuppressSettingsChangeListener listener)	Removes the specified listener.

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

activate, deactivate

Field Details

SERVICE_NAME

static final String SERVICE_NAME

See Also:

• Constant Field Values

Method Details

isSuppressed

boolean isSuppressed(Object object,
 String checkId,
 String checkContributor)

Answers to the question whether the particular check is suppressed for selected object.

Parameters:

object - object to be examined

checkId - check identifier

Returns:

true if the check is suppressed.

excludeSuppressedCheckIds

Set<String> excludeSuppressedCheckIds(org.eclipse.emf.ecore.EObject source,
 org.eclipse.core.resources.IProject project,
 Set<String> checkIds,
 IBslElementRegionProvider bslElementRegionProvider)

Excludes suppressed check ids from set of given check ids.

Parameters:

source - the object being validated, cannot be null

project - the project, can be null

checkIds - , the original set of check ids, cannot be null

bslElementRegionProvider - , the IBslElementRegionProvider, cannot be null

Returns:

the updated set of check ids w/o suppressions, never null

addSuppression

void addSuppression(IBmObject target,
 CheckUid checkUid)

Adds a suppression of the given check for a specified model object

Parameters:

target - The target object. May not be null

checkUid - The identifier of the check to suppress. May not be null

prepareSuppressionSession

SuppressionSessionHandle prepareSuppressionSession()

Creates and registers a new suppression session

Returns:

SuppressionSessionHandle, never null

finishSuppressionSession

void finishSuppressionSession(SuppressionSessionHandle handle)

Finalizes the suppression session

Parameters:

handle - the suppression session handle, cannot be null

addListener

void addListener(ISuppressSettingsChangeListener listener)

Adds the specified ISuppressSettingsChangeListener

Parameters:

listener - the listener to add, cannot be null.

See Also:

• ISuppressSettingsChangeListener

removeListener

void removeListener(ISuppressSettingsChangeListener listener)

Removes the specified listener.

Parameters:

listener - the listener to remove, cannot be null.

See Also:

• ISuppressSettingsChangeListener