IRegistrationBusinessLogic.cs

/********************************************************************************
 * Copyright (c) 2022 Contributors to the Eclipse Foundation
 *
 * See the NOTICE file(s) distributed with this work for additional
 * information regarding copyright ownership.
 *
 * This program and the accompanying materials are made available under the
 * terms of the Apache License, Version 2.0 which is available at
 * https://www.apache.org/licenses/LICENSE-2.0.
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 * License for the specific language governing permissions and limitations
 * under the License.
 *
 * SPDX-License-Identifier: Apache-2.0
 ********************************************************************************/

using Org.Eclipse.TractusX.Portal.Backend.Administration.Service.Models;
using Org.Eclipse.TractusX.Portal.Backend.Clearinghouse.Library.Models;
using Org.Eclipse.TractusX.Portal.Backend.Dim.Library.Models;
using Org.Eclipse.TractusX.Portal.Backend.Framework.Models;
using Org.Eclipse.TractusX.Portal.Backend.IssuerComponent.Library.Models;
using Org.Eclipse.TractusX.Portal.Backend.PortalBackend.DBAccess.Models;
using Org.Eclipse.TractusX.Portal.Backend.PortalBackend.PortalEntities.Enums;
using Org.Eclipse.TractusX.Portal.Backend.SdFactory.Library.Models;

namespace Org.Eclipse.TractusX.Portal.Backend.Administration.Service.BusinessLogic;

public interface IRegistrationBusinessLogic
{
    Task<CompanyWithAddressData> GetCompanyWithAddressAsync(Guid applicationId);
    Task<Pagination.Response<CompanyApplicationDetails>> GetCompanyApplicationDetailsAsync(int page, int size, CompanyApplicationStatusFilter? companyApplicationStatusFilter, string? companyName);
    Task<Pagination.Response<CompanyApplicationWithCompanyUserDetails>> GetAllCompanyApplicationsDetailsAsync(int page, int size, string? companyName);
    Task UpdateCompanyBpn(Guid applicationId, string bpn);

    /// <summary>
    /// Approves the given application.
    /// </summary>
    /// <param name="applicationId">Id of the application</param>
    Task ApproveRegistrationVerification(Guid applicationId);

    /// <summary>
    /// Declines the given application.
    /// </summary>
    /// <param name="applicationId">Id of the application</param>
    /// <param name="comment">Reason of decline</param>
    /// <param name="cancellationToken">cancellation token</param>
    Task DeclineRegistrationVerification(Guid applicationId, string comment, CancellationToken cancellationToken);

    /// <summary>
    /// Processes the clearinghouse response
    /// </summary>
    /// <param name="data">the response data</param>
    /// <param name="bpn">BusinessPartnerNumber of the responded data</param>
    /// <param name="cancellationToken">cancellation token</param>
    Task ProcessClearinghouseResponseAsync(ClearinghouseResponseData data, string bpn, CancellationToken cancellationToken);

    /// <summary>
    /// Processes the dim response
    /// </summary>
    /// <param name="bpn">the companies business partner number</param>
    /// <param name="data">the response data</param>
    /// <param name="cancellationToken"></param>
    Task ProcessDimResponseAsync(string bpn, DimWalletData data, CancellationToken cancellationToken);

    /// <summary>
    /// Gets the checklist details for the given application
    /// </summary>
    /// <param name="applicationId">Id of the application</param>
    /// <returns>Returns the checklist details</returns>
    Task<IEnumerable<ChecklistDetails>> GetChecklistForApplicationAsync(Guid applicationId);

    /// <summary>
    /// Regtrigger the failed checklist entry or the specific given checklist entry
    /// </summary>
    /// <param name="applicationId">Id of the application</param>
    /// <param name="entryTypeId">The checklist entry type that should be retriggered</param>
    /// <param name="processStepTypeId">The processTypeId that should be retriggered</param>
    Task TriggerChecklistAsync(Guid applicationId, ApplicationChecklistEntryTypeId entryTypeId, ProcessStepTypeId processStepTypeId);

    /// <summary>
    /// Processes the clearinghouse self description
    /// </summary>
    /// <param name="data">The response data</param>
    /// <param name="cancellationToken">CancellationToken</param>
    Task ProcessClearinghouseSelfDescription(SelfDescriptionResponseData data, CancellationToken cancellationToken);

    /// <summary>
    /// Gets the document with the given id
    /// </summary>
    /// <param name="documentId">Id of the document to get</param>
    /// <returns>Returns the filename and content of the file</returns>
    Task<(string fileName, byte[] content, string contentType)> GetDocumentAsync(Guid documentId);

    /// <summary>
    /// Processes the issuer bpn response
    /// </summary>
    /// <param name="data">the response data</param>
    /// <param name="cancellationToken">cancellation token</param>
    Task ProcessIssuerBpnResponseAsync(IssuerResponseData data, CancellationToken cancellationToken);

    /// <summary>
    /// Processes the issuer membership response
    /// </summary>
    /// <param name="data">the response data</param>
    /// <param name="cancellationToken">cancellation token</param>
    Task ProcessIssuerMembershipResponseAsync(IssuerResponseData data, CancellationToken cancellationToken);

    /// <summary>
    /// Retrigger the DeleteIdpSharedRealm ProcessStepType
    /// </summary>
    /// <param name="processId">Id of the Process</param>
    Task RetriggerDeleteIdpSharedRealm(Guid processId);

    /// <summary>
    /// Retrigger the DeleteIdpSharedServiceAccount ProcessStepType
    /// </summary>
    /// <param name="processId">Id of the Process</param>
    Task RetriggerDeleteIdpSharedServiceAccount(Guid processId);

    /// <summary>
    /// Retrigger the DeleteCentralIdentityProvider ProcessStepType
    /// </summary>
    /// <param name="processId">Id of the Process</param>
    Task RetriggerDeleteCentralIdentityProvider(Guid processId);

    /// <summary>
    /// Retrigger the DeleteCentralUser ProcessStepType
    /// </summary>
    /// <param name="processId">Id of the Process</param>
    Task RetriggerDeleteCentralUser(Guid processId);
}