aswi2021bc304crew-gitlab/docs/Leuze.Core.Domain.xml @ 26c8b06f

<?xml version="1.0"?>
<doc>
    <assembly>
        <name>Leuze.Core.Domain</name>
    </assembly>
    <members>
        <member name="T:Leuze.Core.Domain.Domains.BaseDomainEvent">
            <summary>
                Base class for domain events.
            </summary>
        </member>
        <member name="M:Leuze.Core.Domain.Domains.BaseDomainEvent.SetAsSystemEvent">
            <inheritdoc />
        </member>
        <member name="P:Leuze.Core.Domain.Domains.BaseDomainEvent.IsSystemEvent">
            <inheritdoc />
        </member>
        <member name="P:Leuze.Core.Domain.Domains.BaseDomainEvent.CreatedOn">
            <inheritdoc/>
        </member>
        <member name="T:Leuze.Core.Domain.Domains.BaseDomainEventHandler`1">
            <summary>
                Base class for domain event handlers.
            </summary>
            <typeparam name="TDomainEvent">The type of the domain event.</typeparam>
        </member>
        <member name="M:Leuze.Core.Domain.Domains.BaseDomainEventHandler`1.Handle(`0,System.Threading.CancellationToken)">
            <summary>
                Handles the domain event.
            </summary>
            <param name="domainEvent">The domain event.</param>
            <param name="cancellationToken">The cancellation token.</param>
            <returns>A task.</returns>
        </member>
        <member name="T:Leuze.Core.Domain.Domains.BaseEntity">
            <summary>
            Base abstract class for all entities in core business processes.
            </summary>
        </member>
        <member name="F:Leuze.Core.Domain.Domains.BaseEntity._createdBy">
            <summary>
            
            </summary>
        </member>
        <member name="P:Leuze.Core.Domain.Domains.BaseEntity.CreatedBy">
            <inheritdoc />
        </member>
        <member name="F:Leuze.Core.Domain.Domains.BaseEntity._createdOn">
            <summary>
            
            </summary>
        </member>
        <member name="P:Leuze.Core.Domain.Domains.BaseEntity.CreatedOn">
            <inheritdoc />
        </member>
        <member name="F:Leuze.Core.Domain.Domains.BaseEntity._lastModifiedBy">
            <summary>
            
            </summary>
        </member>
        <member name="P:Leuze.Core.Domain.Domains.BaseEntity.LastModifiedBy">
            <inheritdoc />
        </member>
        <member name="F:Leuze.Core.Domain.Domains.BaseEntity._lastModifiedOn">
            <summary>
            
            </summary>
        </member>
        <member name="P:Leuze.Core.Domain.Domains.BaseEntity.LastModifiedOn">
            <inheritdoc />
        </member>
        <member name="M:Leuze.Core.Domain.Domains.BaseEntity.AuditCreation(System.String)">
            <inheritdoc />
        </member>
        <member name="M:Leuze.Core.Domain.Domains.BaseEntity.AuditModification(System.String)">
            <inheritdoc />
        </member>
        <member name="P:Leuze.Core.Domain.Domains.BaseEntity.DomainEvents">
            <inheritdoc />
        </member>
        <member name="M:Leuze.Core.Domain.Domains.BaseEntity.AddDomainEvent(Leuze.Core.Domain.Domains.IDomainEvent)">
            <inheritdoc />
        </member>
        <member name="M:Leuze.Core.Domain.Domains.BaseEntity.ClearDomainEvents">
            <inheritdoc />
        </member>
        <member name="T:Leuze.Core.Domain.Domains.IAuditableEntity">
            <summary>
                An interface that defines an entity which provides timestamps of entity modifications.
            </summary>
        </member>
        <member name="P:Leuze.Core.Domain.Domains.IAuditableEntity.CreatedBy">
            <summary>
                An user who created the entity.
            </summary>
        </member>
        <member name="P:Leuze.Core.Domain.Domains.IAuditableEntity.CreatedOn">
            <summary>
                A date when the entity was created.
            </summary>
        </member>
        <member name="P:Leuze.Core.Domain.Domains.IAuditableEntity.LastModifiedBy">
            <summary>
                A last user who modified the entity.
            </summary>
        </member>
        <member name="P:Leuze.Core.Domain.Domains.IAuditableEntity.LastModifiedOn">
            <summary>
                A last modification date.
            </summary>
        </member>
        <member name="M:Leuze.Core.Domain.Domains.IAuditableEntity.AuditCreation(System.String)">
            <summary>
                Audits the entity and stores the creation date and the user identifier.
            <para>
                If the identifier of the user's who created the entity is not provided, the null value will be used that states the system done the creation.
            </para>
            </summary>
            <param name="createdBy">The user identifier.</param>
        </member>
        <member name="M:Leuze.Core.Domain.Domains.IAuditableEntity.AuditModification(System.String)">
            <summary>
                Audits the modification of the entity by storing modification date and the user' identifier.
            <para>
                If the identifier of the user's who modified the entity is not provided, the null value will be used that states the system done the modification.
            </para>
            </summary>
            <param name="modifiedBy">The user's identifier. If left blank, system will be used.</param>
        </member>
        <member name="T:Leuze.Core.Domain.Domains.Identity.DTOs.PermissionItem">
            <summary>
            
            </summary>
        </member>
        <member name="M:Leuze.Core.Domain.Domains.Identity.DTOs.PermissionItem.#ctor(System.String,System.String,System.Int32,System.Int32)">
            <summary>
            
            </summary>
        </member>
        <member name="T:Leuze.Core.Domain.Domains.IDomainEntity">
            <summary>
            
            </summary>
        </member>
        <member name="P:Leuze.Core.Domain.Domains.IDomainEntity.DomainEvents">
            <summary>
            
            </summary>
        </member>
        <member name="M:Leuze.Core.Domain.Domains.IDomainEntity.AddDomainEvent(Leuze.Core.Domain.Domains.IDomainEvent)">
            <summary>
            
            </summary>
            <param name="domainEvent"></param>
        </member>
        <member name="M:Leuze.Core.Domain.Domains.IDomainEntity.ClearDomainEvents">
            <summary>
            
            </summary>
            <returns></returns>
        </member>
        <member name="T:Leuze.Core.Domain.Domains.IDomainEvent">
            <summary>
            
            </summary>
        </member>
        <member name="M:Leuze.Core.Domain.Domains.IDomainEvent.SetAsSystemEvent">
            <summary>
                Sets the domain event as an system event. The initiator of the event will not be resolved.
            </summary>
        </member>
        <member name="P:Leuze.Core.Domain.Domains.IDomainEvent.IsSystemEvent">
            <summary>
                Determines whether the domain event is made by the system.
            </summary>
        </member>
        <member name="P:Leuze.Core.Domain.Domains.IDomainEvent.CreatedOn">
            <summary>
                Date when domain event was created.
            </summary>
        </member>
        <member name="T:Leuze.Core.Domain.Domains.Shared.Enums.EnumExtensions">
            <summary>
            
            </summary>
        </member>
        <member name="M:Leuze.Core.Domain.Domains.Shared.Enums.EnumExtensions.ToDescriptionString(System.Enum)">
            <summary>
            
            </summary>
            <param name="val"></param>
            <returns></returns>
        </member>
        <member name="T:Leuze.Core.Domain.Domains.Shared.ValueObjects.EmailAddress">
            <summary>
                Email address record type with validation logic for email addresses.
            </summary>
        </member>
        <member name="M:Leuze.Core.Domain.Domains.Shared.ValueObjects.EmailAddress.#ctor">
            <summary>
                Private constructor for Entity Framework.
            </summary>
        </member>
        <member name="M:Leuze.Core.Domain.Domains.Shared.ValueObjects.EmailAddress.#ctor(System.String)">
            <summary>
                Creates a new email address.
            </summary>
            <param name="email">The email address.</param>
            <exception cref="T:System.InvalidOperationException">Thrown when the <paramref name="email"/> is not in valid format.</exception>
        </member>
        <member name="P:Leuze.Core.Domain.Domains.Shared.ValueObjects.EmailAddress.Email">
            <summary>
                The email address.
            </summary>
        </member>
        <member name="M:Leuze.Core.Domain.Domains.Shared.ValueObjects.EmailAddress.Validate(System.String)">
            <summary>
                Validates the correct format of email address.
            </summary>
            <param name="emailAddress">The email address to be validated.</param>
            <returns>Whether the email address is valid.</returns>
        </member>
        <member name="T:Leuze.Core.Domain.Domains.Shared.ValueObjects.PersonFullName">
            <summary>
                Record type holding a person's first name nad last name.
            </summary>
        </member>
        <member name="M:Leuze.Core.Domain.Domains.Shared.ValueObjects.PersonFullName.#ctor">
            <summary>
                Private constructor for Entity Framework.
            </summary>
        </member>
        <member name="M:Leuze.Core.Domain.Domains.Shared.ValueObjects.PersonFullName.#ctor(System.String,System.String)">
            <summary>
                Creates a <see cref="T:Leuze.Core.Domain.Domains.Shared.ValueObjects.PersonFullName"/> with required properties.
            </summary>
            <param name="firstName">The first name.</param>
            <param name="lastName">The last name.</param>
        </member>
        <member name="P:Leuze.Core.Domain.Domains.Shared.ValueObjects.PersonFullName.FirstName">
            <summary>
                The first name.
            </summary>
        </member>
        <member name="P:Leuze.Core.Domain.Domains.Shared.ValueObjects.PersonFullName.LastName">
            <summary>
                The last name.
            </summary>
        </member>
        <member name="M:Leuze.Core.Domain.Domains.Shared.ValueObjects.PersonFullName.ToString">
            <summary>
                Gets the full name of the person.
            </summary>
            <returns>The full name.</returns>
        </member>
        <member name="M:Leuze.Core.Domain.Domains.Shared.ValueObjects.PersonFullName.GetFullName">
            <summary>
                Gets a full name.
            </summary>
            <returns>The full name.</returns>
        </member>
        <member name="T:Leuze.Core.Domain.Domains.Shared.ValueObjects.PhoneNumber">
            <summary>
            
            </summary>
        </member>
        <member name="M:Leuze.Core.Domain.Domains.Shared.ValueObjects.PhoneNumber.#ctor">
            <summary>
                Private constructor for Entity Framework.
            </summary>
        </member>
        <member name="M:Leuze.Core.Domain.Domains.Shared.ValueObjects.PhoneNumber.#ctor(System.String,System.String)">
            <summary>
            
            </summary>
            <param name="prefix"></param>
            <param name="number"></param>
        </member>
        <member name="P:Leuze.Core.Domain.Domains.Shared.ValueObjects.PhoneNumber.Prefix">
            <summary>
            
            </summary>
        </member>
        <member name="P:Leuze.Core.Domain.Domains.Shared.ValueObjects.PhoneNumber.Number">
            <summary>
            
            </summary>
        </member>
        <member name="M:Leuze.Core.Domain.Domains.Shared.ValueObjects.PhoneNumber.ToString">
            <summary>
            
            </summary>
            <returns></returns>
        </member>
        <member name="M:Leuze.Core.Domain.Domains.Shared.ValueObjects.PhoneNumber.GetPhoneNumber">
            <summary>
            
            </summary>
            <returns></returns>
        </member>
        <member name="T:Leuze.Core.Domain.Domains.Users.DomainUser">
            <summary>
                The domain user that is the root of all users in the system.
                Each domain has it's own representation of their domain specific users that are linked to this entity.
            </summary>
        </member>
        <member name="M:Leuze.Core.Domain.Domains.Users.DomainUser.#ctor">
            <summary>
                Private constructor for Entity Framework.
            </summary>
        </member>
        <member name="M:Leuze.Core.Domain.Domains.Users.DomainUser.NewUser(System.Guid)">
            <summary>
            
            </summary>
            <param name="userId"></param>
            <returns></returns>
        </member>
        <member name="P:Leuze.Core.Domain.Domains.Users.DomainUser.UserId">
            <summary>
                The user's identifier from identity provider.
            </summary>
        </member>
        <member name="T:Leuze.Core.Domain.Domains.Users.Services.Abstractions.IDomainUserProvider">
            <summary>
                Domain user provider for external layers to provide current user that uses the business domains.
            </summary>
        </member>
        <member name="P:Leuze.Core.Domain.Domains.Users.Services.Abstractions.IDomainUserProvider.CurrentUserId">
            <summary>
                The identifier of business user.
            </summary>
        </member>
        <member name="M:Leuze.Core.Domain.Domains.Users.Services.Abstractions.IDomainUserProvider.GetCurrentUserAsync">
            <summary>
                Gets the current business user.
            </summary>
            <returns>The current business user.</returns>
        </member>
        <member name="T:Leuze.Core.Domain.Localization.Time.ITimeProvider">
            <summary>
                Provides unified time accessor to other system components.
            </summary>
        </member>
        <member name="P:Leuze.Core.Domain.Localization.Time.ITimeProvider.Now">
            <summary>
                Gets a <see cref="T:System.DateTime" /> object that is set to the current date and time on current execution
                environment.
            </summary>
        </member>
        <member name="T:Leuze.Core.Domain.Localization.Time.SystemTime">
            <summary>
                Singleton time accessor for system components.
            </summary>
            <remarks>Default <see cref="T:Leuze.Core.Domain.Localization.Time.ITimeProvider" /> is set to <see cref="T:Leuze.Core.Domain.Localization.Time.UtcTimeProvider" />.</remarks>
        </member>
        <member name="P:Leuze.Core.Domain.Localization.Time.SystemTime.Provider">
            <summary>
                Injected provider with time accessor. Unless assigned explicitly, a <see cref="T:Leuze.Core.Domain.Localization.Time.UtcTimeProvider" /> is used as
                default implementation.
            </summary>
        </member>
        <member name="P:Leuze.Core.Domain.Localization.Time.SystemTime.Now">
            <summary>
                Gets a <see cref="T:System.DateTime" /> object that is set to the current date and time in current
                <see cref="T:Leuze.Core.Domain.Localization.Time.ITimeProvider" /> instance.
            </summary>
        </member>
        <member name="M:Leuze.Core.Domain.Localization.Time.SystemTime.SetProvider(Leuze.Core.Domain.Localization.Time.ITimeProvider)">
            <summary>
                Injects provider dependency into current execution environment.
            </summary>
            <param name="provider">The <see cref="T:Leuze.Core.Domain.Localization.Time.ITimeProvider" /> for current execution environment.</param>
        </member>
        <member name="T:Leuze.Core.Domain.Localization.Time.UtcTimeProvider">
            <summary>
                Provides Coordinated Universal Time (UTC) time accessor to other system components.
            </summary>
        </member>
        <member name="P:Leuze.Core.Domain.Localization.Time.UtcTimeProvider.Now">
            <summary>
                Gets a <see cref="T:System.DateTime" /> object that is set to the current date and time on current execution
                environment, expressed as the Coordinated Universal Time (UTC).
            </summary>
        </member>
        <member name="T:Leuze.Core.Domain.Repositories.IPermissionRepository">
            <summary>
            
            </summary>
        </member>
        <member name="M:Leuze.Core.Domain.Repositories.IPermissionRepository.AddAsync(Leuze.Core.Application.Identity.ApplicationPermission)">
            <summary>
            
            </summary>
            <param name="entity"></param>
            <returns></returns>
        </member>
        <member name="M:Leuze.Core.Domain.Repositories.IPermissionRepository.ToListAsync">
            <summary>
            
            </summary>
            <returns></returns>
        </member>
        <member name="M:Leuze.Core.Domain.Repositories.IPermissionRepository.RemoveRangeAsync(System.Collections.Generic.IEnumerable{Leuze.Core.Application.Identity.ApplicationPermission})">
            <summary>
            
            </summary>
            <param name="list"></param>
            <returns></returns>
        </member>
        <member name="M:Leuze.Core.Domain.Repositories.IPermissionRepository.GetFilteredList">
            <summary>
            
            </summary>
            <returns></returns>
        </member>
        <member name="M:Leuze.Core.Domain.Repositories.IPermissionRepository.GetListByIdsAsync(System.Collections.Generic.IList{System.Guid})">
            <summary>
            
            </summary>
            <param name="permissions"></param>
            <returns></returns>
        </member>
        <member name="T:Leuze.Core.Domain.Repositories.IRoleRepository">
            <summary>
            
            </summary>
        </member>
        <member name="M:Leuze.Core.Domain.Repositories.IRoleRepository.CreateAsync(Leuze.Core.Application.Identity.ApplicationRole)">
            <summary>
            
            </summary>
            <param name="role"></param>
            <returns></returns>
        </member>
        <member name="T:Leuze.Core.Domain.Repositories.IUserRepository">
            <summary>
            
            </summary>
        </member>
        <member name="T:Leuze.Core.Domain.Services.IEmailSender">
            <summary>
                General interface for custom email sender providers.
            </summary>
        </member>
        <member name="M:Leuze.Core.Domain.Services.IEmailSender.SendAsync``1(Leuze.Core.Domain.Services.Models.Email.BaseEmailTemplate{``0})">
            <summary>
            
            </summary>
            <typeparam name="TValuesType"></typeparam>
            <param name="template"></param>
            <returns></returns>
        </member>
        <member name="T:Leuze.Core.Domain.Services.Models.Email.BaseEmailTemplate`1">
            <summary>
            
            </summary>
            <typeparam name="TValuesType"></typeparam>
        </member>
        <member name="P:Leuze.Core.Domain.Services.Models.Email.BaseEmailTemplate`1.From">
            <summary>
            
            </summary>
        </member>
        <member name="P:Leuze.Core.Domain.Services.Models.Email.BaseEmailTemplate`1.To">
            <summary>
            
            </summary>
        </member>
        <member name="P:Leuze.Core.Domain.Services.Models.Email.BaseEmailTemplate`1.Subject">
            <summary>
            
            </summary>
        </member>
        <member name="P:Leuze.Core.Domain.Services.Models.Email.BaseEmailTemplate`1.Values">
            <summary>
            
            </summary>
        </member>
        <member name="P:Leuze.Core.Domain.Services.Models.Email.BaseEmailTemplate`1.TemplatePath">
            <summary>
            
            </summary>
        </member>
        <member name="M:Leuze.Core.Domain.Services.Models.Email.BaseEmailTemplate`1.#ctor(System.Net.Mail.MailAddress,System.Net.Mail.MailAddress,System.String,`0,System.String)">
            <summary>
            
            </summary>
            <param name="from"></param>
            <param name="to"></param>
            <param name="subject"></param>
            <param name="values"></param>
            <param name="templatePath"></param>
        </member>
    </members>
</doc>