/// <summary>
/// Creates a new Permission.
/// </summary>
/// <param name="name">Unique name of the permission</param>
/// <param name="displayName">Display name of the permission</param>
/// <param name="isGrantedByDefault">Is this permission granted by default</param>
/// <param name="description">A brief description for this permission</param>
public PermissionDefinition(string name, LocalizableString displayName, bool isGrantedByDefault = false, LocalizableString description = null)
{
Name = name;
DisplayName = displayName;
IsGrantedByDefault = isGrantedByDefault;
Description = description;
}
/// <summary>
/// Creates a new <see cref="SettingDefinition"/> object.
/// </summary>
/// <param name="name">Unique name of the setting</param>
/// <param name="defaultValue">Default value of the setting</param>
/// <param name="displayName">Display name of the permission</param>
/// <param name="group">Group of this setting</param>
/// <param name="description">A brief description for this setting</param>
/// <param name="scopes">Scopes of this setting</param>
public SettingDefinition(string name, string defaultValue, LocalizableString displayName = null, SettingDefinitionGroup group = null, LocalizableString description = null, SettingScopes scopes = SettingScopes.Application)
{
Name = name;
DefaultValue = defaultValue;
DisplayName = displayName;
Group = @group;
Description = description;
Scopes = scopes;
}
/// <summary>
/// Creates a new <see cref="SettingDefinition"/> object.
/// </summary>
/// <param name="name">Unique name of the setting</param>
/// <param name="defaultValue">Default value of the setting</param>
/// <param name="displayName">Display name of the permission</param>
/// <param name="group">Group of this setting</param>
/// <param name="description">A brief description for this setting</param>
/// <param name="scopes">Scopes of this setting. Default value: <see cref="SettingScopes.Application"/>.</param>
/// <param name="isVisibleToClients">Can clients see this setting and it's value</param>
public SettingDefinition(string name, string defaultValue, LocalizableString displayName = null, SettingDefinitionGroup group = null, LocalizableString description = null, SettingScopes scopes = SettingScopes.Application, bool isVisibleToClients = false)
{
Name = name;
DefaultValue = defaultValue;
DisplayName = displayName;
Group = @group;
Description = description;
Scopes = scopes;
IsVisibleToClients = isVisibleToClients;
}
/// <summary>
/// Creates a new <see cref="SettingDefinitionGroup"/> object.
/// </summary>
/// <param name="name">Unique name of the setting group</param>
/// <param name="displayName">Display name of the setting</param>
public SettingDefinitionGroup(string name, LocalizableString displayName)
{
if (string.IsNullOrWhiteSpace(name))
{
throw new ArgumentException("name parameter is invalid! It can not be null or empty or whitespace", "name"); //TODO: Simpify throwing such exceptions
}
Name = name;
DisplayName = displayName;
_children = new List<SettingDefinitionGroup>();
}
/// <summary>
/// Creates a new <see cref="PermissionGroup"/> object.
/// </summary>
internal PermissionGroup(string name, LocalizableString displayName)
{
if (name == null)
{
throw new ArgumentNullException("name");
}
if (displayName == null)
{
throw new ArgumentNullException("displayName");
}
Name = name;
DisplayName = displayName;
_children = new List<PermissionGroup>();
_permissions = new List<Permission>();
}
/// <summary>
/// Creates a new Permission.
/// </summary>
/// <param name="name">Unique name of the permission</param>
/// <param name="displayName">Display name of the permission</param>
/// <param name="isGrantedByDefault">Is this permission granted by default. Default value: false.</param>
/// <param name="description">A brief description for this permission</param>
internal Permission(string name, LocalizableString displayName, bool isGrantedByDefault = false, LocalizableString description = null)
{
if (name == null)
{
throw new ArgumentNullException("name");
}
if (displayName == null)
{
throw new ArgumentNullException("displayName");
}
Name = name;
DisplayName = displayName;
IsGrantedByDefault = isGrantedByDefault;
Description = description;
_children = new List<Permission>();
}
/// <summary>
/// Gets a localized string in specified language.
/// </summary>
/// <returns>Localized string</returns>
public static string GetString(this ILocalizationManager localizationManager, LocalizableString localizableString, CultureInfo culture)
{
return localizationManager.GetString(localizableString.SourceName, localizableString.Name, culture);
}
public PermissionGroup CreateRootGroup(string name, LocalizableString displayName)
{
if (_rootGroups.ContainsKey(name))
{
throw new AbpInitializationException(
string.Format(
"There is already a root permission group named '{0}'. Try to get it using GetRootGroupOrNull method",
name));
}
var permissionGroup = new PermissionGroup(name, displayName);
_rootGroups[name] = permissionGroup;
return permissionGroup;
}
/// <summary>
/// Adds a child permission.
/// A child permission can be granted only if parent is granted.
/// </summary>
/// <returns>Returns new child permission</returns>
public Permission CreateChildPermission(string name, LocalizableString displayName, bool isGrantedByDefault = false, LocalizableString description = null)
{
var permission = new Permission(name, displayName, isGrantedByDefault, description) { Parent = this };
_children.Add(permission);
return permission;
}
/// <summary>
/// Initializes a new instance of the <see cref="LocalizableMessageNotificationData"/> class.
/// </summary>
/// <param name="message">The message.</param>
public LocalizableMessageNotificationData(LocalizableString message)
{
Message = message;
}
/// <summary>
/// Creates a new child permission group under this group.
/// </summary>
/// <param name="name">Unique name of the group</param>
/// <param name="displayName">Display name of the group</param>
/// <returns>Created child permission group object</returns>
public PermissionGroup CreateChildGroup(string name, LocalizableString displayName)
{
var childGroup = new PermissionGroup(name, displayName) { Parent = this };
_children.Add(childGroup);
return childGroup;
}
/// <summary>
/// Creates a new permission under this group.
/// </summary>
/// <param name="name">Unique name of the permission</param>
/// <param name="displayName">Display name of the permission</param>
/// <param name="isGrantedByDefault">Is this permission granted by default. Default value: false.</param>
/// <param name="description">A brief description for this permission</param>
/// <returns>New created permission</returns>
public Permission CreatePermission(string name, LocalizableString displayName, bool isGrantedByDefault = false, LocalizableString description = null)
{
var permission = new Permission(name, displayName, isGrantedByDefault, description);
_permissions.Add(permission);
return permission;
}
