com.zepben.evolve.services.customer.CustomerServiceUtils.kt Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of evolve-sdk Show documentation
SDK for interaction with the evolve platform
There is a newer version: 0.24.0rc1
/*
 * Copyright 2020 Zeppelin Bend Pty Ltd
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at https://mozilla.org/MPL/2.0/.
 */


@file:JvmName("CustomerServiceUtils")

package com.zepben.evolve.services.customer

import com.zepben.evolve.cim.iec61968.common.Organisation
import com.zepben.evolve.cim.iec61968.customers.Customer
import com.zepben.evolve.cim.iec61968.customers.CustomerAgreement
import com.zepben.evolve.cim.iec61968.customers.PricingStructure
import com.zepben.evolve.cim.iec61968.customers.Tariff
import com.zepben.evolve.cim.iec61970.base.core.IdentifiedObject

/**
 * A function that provides an exhaustive `when` style statement for all [IdentifiedObject] leaf types supported by
 * the [CustomerService]. If the provided [identifiedObject] is not supported by the service the [isOther] handler
 * is invoked which by default will throw an [IllegalArgumentException]
 *
 * By using this function, you acknowledge that if any new types are added to the customer service, and thus this
 * function, it will cause a compilation error when updating to the new version. This should reduce errors due to
 * missed handling of new types introduced to the model. As this is intended behaviour it generally will not be
 * considered a breaking change in terms of semantic versioning of this library.
 *
 * If it is not critical that all types within the service are always handled, it is recommended to use a typical
 * `when` statement (Kotlin) or if-else branch (Java) and update new cases as required without breaking your code.
 *
 * @param identifiedObject The identified object to handle.
 * @param isCustomer Handler when the [identifiedObject] is a [Customer]
 * @param isCustomerAgreement Handler when the [identifiedObject] is a [CustomerAgreement]
 * @param isOrganisation Handler when the [identifiedObject] is a [Organisation]
 * @param isPricingStructure Handler when the [identifiedObject] is a [PricingStructure]
 * @param isTariff Handler when the [identifiedObject] is a [Tariff]
 * @param isOther Handler when the [identifiedObject] is not supported by the [CustomerService].
 */
@JvmOverloads
inline fun  whenCustomerServiceObject(
    identifiedObject: IdentifiedObject,
    isCustomer: (Customer) -> R,
    isCustomerAgreement: (CustomerAgreement) -> R,
    isOrganisation: (Organisation) -> R,
    isPricingStructure: (PricingStructure) -> R,
    isTariff: (Tariff) -> R,
    isOther: (IdentifiedObject) -> R = { idObj: IdentifiedObject ->
        throw IllegalArgumentException("Identified object type ${idObj::class} is not supported by the customer service")
    }
): R = when (identifiedObject) {
    is Customer -> isCustomer(identifiedObject)
    is CustomerAgreement -> isCustomerAgreement(identifiedObject)
    is Organisation -> isOrganisation(identifiedObject)
    is PricingStructure -> isPricingStructure(identifiedObject)
    is Tariff -> isTariff(identifiedObject)
    else -> isOther(identifiedObject)
}