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

Class CheckSettingsChange

java.lang.Object

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

public final class CheckSettingsChange
extends Object

The difference between the previous state of the check settings and the last one. Used by the ICheckSettingsChangeListener lifecycle to perform selective changes in check-related data (e.g. markers, etc) This class isn't intended for the direct instantiation or changes by the clients

Constructor Summary

Constructors

Constructor	Description
CheckSettingsChange(CheckUid checkId)	Constructs an instance of the CheckSettingsChange

Method Summary

Modifier and Type	Method	Description
CheckUid	getCheckId()	Gets the check identifier
IssueSeverity	getNewSeverity()	Gest the new severity (if set)
boolean	isDisabled()	Checks if the check is disabled as a result of the settings change
boolean	isEnabled()	Checks if the check is enabled as a result of the settings change
boolean	isSettingsChanged()	Checks if the custom check settings are changed
void	setDisabled()	Set disabled state change flag.
void	setEnabled()	Set enabled state change flag.
void	setNewSeverity(IssueSeverity severity)	Set new severity for target markers
void	setSettingsChanged()	Sets the generic check setting change flag

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CheckSettingsChange

public CheckSettingsChange(CheckUid checkId)

Constructs an instance of the CheckSettingsChange

Parameters:

checkId - The indentifier of the check. May not be null

Method Detail

getCheckId

public CheckUid getCheckId()

Gets the check identifier

Returns:

The check unqiue identifier. May not be null

getNewSeverity

public IssueSeverity getNewSeverity()

Gest the new severity (if set)

Returns:

The new severity setting. May be null if no severity was changed

isDisabled

public boolean isDisabled()

Checks if the check is disabled as a result of the settings change

Returns:

True if the check is disabled

isEnabled

public boolean isEnabled()

Checks if the check is enabled as a result of the settings change

Returns:

True if the check is enabled

isSettingsChanged

public boolean isSettingsChanged()

Checks if the custom check settings are changed

Returns:

True if the check settings are changed

setDisabled

public void setDisabled()

Set disabled state change flag. Must not be called along with setEnabled()

setEnabled

public void setEnabled()

Set enabled state change flag. Must not be called along with setDisabled()

setNewSeverity

public void setNewSeverity(IssueSeverity severity)

Set new severity for target markers

Parameters:

severity - The new severity to set. May not be null

setSettingsChanged

public void setSettingsChanged()

Sets the generic check setting change flag