com.brihaspathee.zeus.service.interfaces.AccountService Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of member-mgmt-service Show documentation
Member Management Service
The newest version!
package com.brihaspathee.zeus.service.interfaces;

import com.brihaspathee.zeus.broker.message.AccountUpdateResponse;
import com.brihaspathee.zeus.domain.entity.PayloadTracker;
import com.brihaspathee.zeus.dto.account.AccountDto;
import com.brihaspathee.zeus.dto.account.AccountList;
import com.brihaspathee.zeus.dto.account.EnrollmentSpanDto;
import com.brihaspathee.zeus.exception.AccountNotFoundException;
import com.brihaspathee.zeus.web.model.AccountMatchParam;
import com.fasterxml.jackson.core.JsonProcessingException;
import reactor.core.publisher.Mono;

import java.time.LocalDate;
import java.util.List;

/**
 * Created in Intellij IDEA
 * User: Balaji Varadharajan
 * Date: 20, April 2022
 * Time: 4:32 PM
 * Project: Zeus
 * Package Name: com.brihaspathee.zeus.service.interfaces
 * To change this template use File | Settings | File and Code Template
 */
public interface AccountService {

    /**
     * Create a new account
     * @param accountDto
     * @return
     */
    AccountDto createAccount(AccountDto accountDto) throws JsonProcessingException;

    /**
     * Update an existing account
     * @param accountDto
     * @return
     */
    AccountDto updateAccount(AccountDto accountDto) throws JsonProcessingException;

    /**
     * Get account by account number
     * @param accountNumber
     * @return
     */
    AccountDto getAccountByNumber(String accountNumber) ;

    /**
     * Get all the accounts
     * @return
     */
    AccountList getAllAccounts();

    /**
     * Process the account information
     * @param payloadTracker
     * @return
     */
    Mono processAccount(PayloadTracker payloadTracker,
                                               AccountDto accountDto) throws JsonProcessingException;

    /**
     * Get enrollment span that matches the plan and group policy id
     * @param accountNumber
     * @param planId
     * @param groupPolicyId
     * @param startDate
     * @return
     */
    EnrollmentSpanDto getMatchingEnrollmentSpan(String accountNumber,
                                                String planId,
                                                String groupPolicyId,
                                                LocalDate startDate);

    /**
     * Get the enrollment span that is prior to the start date
     * @param accountNumber
     * @param startDate
     * @param matchCancelSpans
     * @return
     */
    EnrollmentSpanDto getPriorEnrollmentSpan(String accountNumber,
                                             LocalDate startDate,
                                             boolean matchCancelSpans);

    /**
     * Get matching enrollment spans by the date
     * @param accountNumber
     * @param startDate
     * @param matchCancelSpans
     * @return
     */
    List getMatchingEnrollmentSpan(String accountNumber,
                                                      LocalDate startDate,
                                                      boolean matchCancelSpans);

    /**
     * Get matching enrollment spans by the date if available else return the prior enrollment span
     * @param accountNumber
     * @param startDate
     * @param matchCancelSpans
     * @return
     */
    List getMatchingOrPriorEnrollmentSpan(String accountNumber,
                                                      LocalDate startDate,
                                                      boolean matchCancelSpans);

    /**
     * Get accounts that match the exchange subscriber id and state type code
     * @param accountMatchParam
     * @return
     */
    AccountList getMatchingAccounts(AccountMatchParam accountMatchParam);

    /**
     * Get account by matching with the SSN of the primary subscriber
     * @param ssn
     */
    AccountList getAccountsBySSN(String ssn);

    /**
     * Update the enrollment span status and paid through dates
     * @param enrollmentSpanDto
     */
    void updateEnrollmentSpan(EnrollmentSpanDto enrollmentSpanDto);

    /**
     * Clean up the entire database
     */
    void deleteAll();

}