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

Class CheckDescription

java.lang.Object

com.e1c.g5.v8.dt.internal.check.settings.CheckDescription

All Implemented Interfaces:

ICheckDescription, INamedElement

public class CheckDescription
extends Object
implements ICheckDescription

Immutable implementation for ICheckDescription.

Field Summary

Fields inherited from interface com.e1c.g5.v8.dt.check.settings.INamedElement

ROOT_ID

Constructor Summary

Constructors

Constructor	Description
CheckDescription(CheckUid checkUid, String title, String description, IssueType issueType, boolean enabled, boolean protectedObjectCheckEnabled, boolean criticalDataIntegrityCheck, IssueSeverity severity, CheckUid parentId, Map<String,CheckParameterDefinition> parameters)	Instantiates a new check description.
CheckDescription(CheckUid checkUid, String title, Supplier<String> description, IssueType issueType, boolean enabled, boolean protectedObjectCheckEnabled, boolean criticalDataIntegrityCheck, IssueSeverity severity, CheckUid parentId, Map<String,CheckParameterDefinition> parameters)	Creates new instance.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
String	getDescription()	Returns localized description.
CheckUid	getId()	Returns id
Map<String,CheckParameterDefinition>	getParameters()	Returns the immutable map of check parameters by their names.
CheckUid	getParentId()	Returns category id from extension point "com.e1c.g5.v8.dt.check.category" or null if none.
IssueSeverity	getSeverity()	Returns check severity.
String	getTitle()	Returns localized title.
IssueType	getType()	Returns check type.
int	hashCode()
boolean	isCriticalDataIntegrityCheck()	Checks if this definition describes the critical data integrity check
boolean	isEnabled()	Returns check enabling.
boolean	isProtectedObjectCheckEnabled()	Returns the protected object check mode enablement status
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

CheckDescription

public CheckDescription(CheckUid checkUid,
 String title,
 String description,
 IssueType issueType,
 boolean enabled,
 boolean protectedObjectCheckEnabled,
 boolean criticalDataIntegrityCheck,
 IssueSeverity severity,
 CheckUid parentId,
 Map<String,CheckParameterDefinition> parameters)

Instantiates a new check description.

Parameters:

checkUid - the check unique id, cannot be null.

title - the title, cannot be null.

description - the description, cannot be null.

issueType - the issue type, cannot be null.

enabled - the enabled of the check

protectedObjectCheckEnabled - the protected object check enabled

criticalDataIntegrityCheck - the critical data integrity check

severity - the severity, cannot be null.

parentId - the parent id, means category id from from extension point "com.e1c.g5.v8.dt.check.checks" or null if none

parameters - the parameters, cannot be null.

CheckDescription

public CheckDescription(CheckUid checkUid,
 String title,
 Supplier<String> description,
 IssueType issueType,
 boolean enabled,
 boolean protectedObjectCheckEnabled,
 boolean criticalDataIntegrityCheck,
 IssueSeverity severity,
 CheckUid parentId,
 Map<String,CheckParameterDefinition> parameters)

Creates new instance.

Parameters:

id - check id, not null

title - check title, null if empty

description - check description, null if empty

issueType - check issue type, not null

enabled - enabled default check enablement

protectedObjectCheckEnabled - The protected object check mode enablement

protectedObjectCheckEnabled - The critical data integrity check flag

severity - check severity, not null

parentId - category id from from extension point "com.e1c.g5.v8.dt.check.checks" or null if none

parameters - check properties, not null

Method Details

getId

public CheckUid getId()

Description copied from interface: INamedElement

Returns id

Specified by:

getId in interface INamedElement

Returns:

id, not null

getTitle

public String getTitle()

Description copied from interface: INamedElement

Returns localized title.

Specified by:

getTitle in interface INamedElement

Returns:

title, not null

getDescription

public String getDescription()

Description copied from interface: INamedElement

Returns localized description.

Specified by:

getDescription in interface INamedElement

Returns:

title, not null

getSeverity

public IssueSeverity getSeverity()

Description copied from interface: ICheckDescription

Returns check severity.

Specified by:

getSeverity in interface ICheckDescription

Returns:

check severity, not null

getType

public IssueType getType()

Description copied from interface: ICheckDescription

Returns check type.

Specified by:

getType in interface ICheckDescription

Returns:

check type, not null

getParentId

public CheckUid getParentId()

Description copied from interface: ICheckDescription

Returns category id from extension point "com.e1c.g5.v8.dt.check.category" or null if none.

Specified by:

getParentId in interface ICheckDescription

Specified by:

getParentId in interface INamedElement

Returns:

category or null if none

isEnabled

public boolean isEnabled()

Description copied from interface: ICheckDescription

Returns check enabling.

Specified by:

isEnabled in interface ICheckDescription

Returns:

whether check is enableb

isProtectedObjectCheckEnabled

public boolean isProtectedObjectCheckEnabled()

Description copied from interface: ICheckDescription

Returns the protected object check mode enablement status

Specified by:

isProtectedObjectCheckEnabled in interface ICheckDescription

Returns:

True if the protected object check mode is enabled

isCriticalDataIntegrityCheck

public boolean isCriticalDataIntegrityCheck()

Description copied from interface: ICheckDescription

Checks if this definition describes the critical data integrity check

Specified by:

isCriticalDataIntegrityCheck in interface ICheckDescription

Returns:

True if the check is a critical integrity check

getParameters

public Map<String,CheckParameterDefinition> getParameters()

Description copied from interface: ICheckDescription

Returns the immutable map of check parameters by their names.

Specified by:

getParameters in interface ICheckDescription

Returns:

map of check properties by their names, not null.

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object