com.zepben.evolve.cim.iec61968.customers.CustomerAgreement.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/.
 */

package com.zepben.evolve.cim.iec61968.customers

import com.zepben.evolve.cim.iec61968.common.Agreement
import com.zepben.evolve.services.common.extensions.asUnmodifiable
import com.zepben.evolve.services.common.extensions.getByMRID
import com.zepben.evolve.services.common.extensions.validateReference

/**
 * Agreement between the customer and the service supplier to pay for service at a specific service location. It
 * records certain billing information about the type of service provided at the service location and is used
 * during charge creation to determine the type of service.
 *
 * @property customer Customer for this agreement.
 */
class CustomerAgreement @JvmOverloads constructor(mRID: String = "") : Agreement(mRID) {

    var customer: Customer? = null
        set(value) {
            field =
                if (field == null || field === value) value else throw IllegalStateException("customer has already been set to $field. Cannot set this field again")
        }

    private var _pricingStructures: MutableList? = null

    /**
     * All pricing structures applicable to this customer agreement. The returned collection is read only.
     */
    val pricingStructures: Collection get() = _pricingStructures.asUnmodifiable()

    /**
     * Get the number of entries in the [PricingStructure] collection.
     */
    fun numPricingStructures(): Int = _pricingStructures?.size ?: 0

    /**
     * All pricing structures applicable to this customer agreement.
     *
     * @param mRID the mRID of the required [PricingStructure]
     * @return The [PricingStructure] with the specified [mRID] if it exists, otherwise null
     */
    fun getPricingStructure(mRID: String): PricingStructure? = _pricingStructures?.getByMRID(mRID)

    fun addPricingStructure(pricingStructure: PricingStructure): CustomerAgreement {
        if (validateReference(pricingStructure, ::getPricingStructure, "A PricingStructure"))
            return this

        _pricingStructures = _pricingStructures ?: mutableListOf()
        _pricingStructures!!.add(pricingStructure)

        return this
    }

    fun removePricingStructure(pricingStructure: PricingStructure): Boolean {
        val ret = _pricingStructures?.remove(pricingStructure) == true
        if (_pricingStructures.isNullOrEmpty()) _pricingStructures = null
        return ret
    }

    fun clearPricingStructures(): CustomerAgreement {
        _pricingStructures = null
        return this
    }
}