org.electrocodeogram.cpc.core.api.provider.notification
Interface IEvaluationResult

public interface IEvaluationResult

Return value for INotificationEvaluationProvider.evaluateModification(IClone, List, boolean).

Author:

vw

See Also:

INotificationEvaluationProvider

Nested Class Summary

static class

IEvaluationResult.Action The type of action which should be taken as a result of an evaluation.

Method Summary

IEvaluationResult.Action	getAction() What should be done with this clone? Does the user need to be notified?
java.lang.String	getMessage() Optional notification/warning message which should be displayed to the user.
double	getWeight() The importance of this notification/warning in relation to other events.

Method Detail

getAction

IEvaluationResult.Action getAction()

What should be done with this clone? Does the user need to be notified?

Returns:

IEvaluationResult.Action which should be taken, never null.

getWeight

double getWeight()

The importance of this notification/warning in relation to other events.
The default weight is 1.0.
Only applies to action types IEvaluationResult.Action.NOTIFY and IEvaluationResult.Action.WARN.

Returns:

weight of this event, >= 0.

getMessage

java.lang.String getMessage()

Optional notification/warning message which should be displayed to the user.
Only applies to action types IEvaluationResult.Action.NOTIFY and IEvaluationResult.Action.WARN.

Returns:

a human readable message, NULL if no specific message should be shown.