/// <summary>
/// Initialize a new instance of operation message with the specified information.
/// </summary>
/// <param name="level">The level of the message.</param>
/// <param name="title">The title of the message.</param>
/// <param name="description">The detailed description of the message. The default value of this parameter is <c>null</c>.</param>
public OperationMessage(
OperationMessageLevel level,
[CanBeNull][LocalizationRequired] IHtmlContent title,
[CanBeNull][LocalizationRequired] IHtmlContent description = null)
{
Level = level;
Title = title;
Description = description;
}
/// <summary>
/// Initialize a new instance of operation message with the specified information.
/// </summary>
/// <param name="level">The level of the message.</param>
/// <param name="title">The title of the message.</param>
/// <param name="description">The detailed description of the message. The default value of this parameter is <c>null</c>.</param>
public OperationMessage(
OperationMessageLevel level,
[CanBeNull][LocalizationRequired] string title,
[CanBeNull][LocalizationRequired] string description = null)
{
Level = level;
Title = title;
Description = description;
}
/// <summary>
/// Convert <see cref="OperationMessageLevel" /> to a CSS class names.
/// </summary>
/// <param name="value">The value to converting.</param>
/// <param name="listStyle">The list style of the operation message list.</param>
/// <returns>Converted class names. Using space to split mutilple class names.</returns>
public string MapLevel(OperationMessageLevel value, MessageListStyle listStyle)
{
switch (listStyle)
{
case MessageListStyle.AlertDialog:
case MessageListStyle.AlertDialogClosable:
return MapLevelForAlert(value);
case MessageListStyle.List:
return MapLevelForListItem(value);
default:
throw new ArgumentException("The argument value is not a valid enum item.", nameof(listStyle));
}
}
/// <summary>
/// Add a new message into the message collection.
/// </summary>
/// <param name="collection">The collection of messages to be adding the new message.</param>
/// <param name="level">The level of the new message.</param>
/// <param name="title">The title of the new message.</param>
/// <param name="description">The detailed description of the new message.</param>
/// <returns>The newly added <see cref="OperationMessage" /> object.</returns>
/// <exception cref="ArgumentNullException"><paramref name="collection" /> is <c>null</c>.</exception>
public static OperationMessage Add([NotNull] this ICollection<OperationMessage> collection,
OperationMessageLevel level, [CanBeNull] [LocalizationRequired] string title,
[CanBeNull] [LocalizationRequired] string description = null)
{
if (collection == null)
{
throw new ArgumentNullException(nameof(collection));
}
var item = new OperationMessage(level, title, description);
collection.Add(item);
return item;
}
/// <summary>
/// Add a new message into the message collection.
/// </summary>
/// <param name="collection">The collection of messages to be adding the new message.</param>
/// <param name="level">The level of the new message.</param>
/// <param name="title">The title of the new message.</param>
/// <param name="description">The detailed description of the new message.</param>
/// <returns>The newly added <see cref="OperationMessage" /> object.</returns>
/// <exception cref="ArgumentNullException"><paramref name="collection" /> is <c>null</c>.</exception>
public static OperationMessage Add([NotNull] this ICollection <OperationMessage> collection,
OperationMessageLevel level, [CanBeNull][LocalizationRequired] string title,
[CanBeNull][LocalizationRequired] string description = null)
{
if (collection == null)
{
throw new ArgumentNullException(nameof(collection));
}
var item = new OperationMessage(level, title, description);
collection.Add(item);
return(item);
}
/// <summary>
/// Convert <see cref="OperationMessageLevel" /> to a CSS class names.
/// </summary>
/// <param name="value">The value to converting.</param>
/// <param name="listStyle">The list style of the operation message list.</param>
/// <returns>Converted class names. Using space to split mutilple class names.</returns>
public string MapLevel(OperationMessageLevel value, MessageListStyle listStyle)
{
switch (listStyle)
{
case MessageListStyle.AlertDialog:
case MessageListStyle.AlertDialogClosable:
return(MapLevelForAlert(value));
case MessageListStyle.List:
return(MapLevelForListItem(value));
default:
throw new ArgumentException("The argument value is not a valid enum item.", nameof(listStyle));
}
}
/// <summary>
/// Add a new message into the message collection.
/// </summary>
/// <param name="messageAccessor">The collection of messages to be adding the new message.</param>
/// <param name="level">The level of the new message.</param>
/// <param name="title">The title of the new message.</param>
/// <param name="description">The detailed description of the new message.</param>
/// <returns>The newly added <see cref="OperationMessage" /> object.</returns>
/// <exception cref="ArgumentNullException"><paramref name="messageAccessor" /> is <c>null</c>.</exception>
public static OperationMessage Add([NotNull] this IOperationMessageAccessor messageAccessor,
OperationMessageLevel level, [CanBeNull][LocalizationRequired] string title,
[CanBeNull][LocalizationRequired] string description = null)
{
if (messageAccessor == null)
{
throw new ArgumentNullException(nameof(messageAccessor));
}
var item = new OperationMessage(level, title, description);
messageAccessor.Messages.Add(item);
return(item);
}
/// <summary>
/// Convert <see cref="OperationMessageLevel" /> to class names used for list group.
/// </summary>
/// <param name="value">The value to converting.</param>
/// <returns>Converted class name.</returns>
private static string MapLevelForListItem(OperationMessageLevel value)
{
switch (value)
{
case OperationMessageLevel.Critical:
case OperationMessageLevel.Error:
return "list-group-item-danger";
case OperationMessageLevel.Info:
return "list-group-item-info";
case OperationMessageLevel.Success:
return "list-group-item-success";
case OperationMessageLevel.Verbose:
return "list-group-item-muted";
case OperationMessageLevel.Warning:
return "list-group-item-warning";
default:
return "";
}
}
/// <summary>
/// Convert <see cref="OperationMessageLevel" /> to class names used for alert dialog.
/// </summary>
/// <param name="value">The value to converting.</param>
/// <returns>Converted class name.</returns>
private static string MapLevelForAlert(OperationMessageLevel value)
{
switch (value)
{
case OperationMessageLevel.Critical:
case OperationMessageLevel.Error:
return "alert-danger";
case OperationMessageLevel.Info:
return "alert-info";
case OperationMessageLevel.Success:
return "alert-success";
case OperationMessageLevel.Verbose:
return "alert-muted";
case OperationMessageLevel.Warning:
return "alert-warning";
default:
return "";
}
}
/// <summary>
/// Convert <see cref="OperationMessageLevel" /> to class names used for list group.
/// </summary>
/// <param name="value">The value to converting.</param>
/// <returns>Converted class name.</returns>
private static string MapLevelForListItem(OperationMessageLevel value)
{
switch (value)
{
case OperationMessageLevel.Critical:
case OperationMessageLevel.Error:
return("list-group-item-danger");
case OperationMessageLevel.Info:
return("list-group-item-info");
case OperationMessageLevel.Success:
return("list-group-item-success");
case OperationMessageLevel.Verbose:
return("list-group-item-muted");
case OperationMessageLevel.Warning:
return("list-group-item-warning");
default:
return("");
}
}
/// <summary>
/// Convert <see cref="OperationMessageLevel" /> to class names used for alert dialog.
/// </summary>
/// <param name="value">The value to converting.</param>
/// <returns>Converted class name.</returns>
private static string MapLevelForAlert(OperationMessageLevel value)
{
switch (value)
{
case OperationMessageLevel.Critical:
case OperationMessageLevel.Error:
return("alert-danger");
case OperationMessageLevel.Info:
return("alert-info");
case OperationMessageLevel.Success:
return("alert-success");
case OperationMessageLevel.Verbose:
return("alert-muted");
case OperationMessageLevel.Warning:
return("alert-warning");
default:
return("");
}
}
public void Should_map_the_specified_Severity_to_the_expected_OperationMessageLevel(Severity severity, OperationMessageLevel expected)
{
// Arrange
var sut = new DefaultValidationSeverityMapper();
// Act
var actual = sut.Map(severity);
// Assert
Assert.Equal(expected, actual);
}
