// --------------------------------------------------------------------------------
// Copyright 2002-2026 Echo Three, LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://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.
// --------------------------------------------------------------------------------
// Generated File -- DO NOT EDIT BY HAND
// --------------------------------------------------------------------------------

/**
 * BillingAccountDetail.java
 */

package com.echothree.model.data.payment.server.entity;

import com.echothree.model.data.payment.common.pk.BillingAccountDetailPK;

import com.echothree.model.data.payment.common.pk.BillingAccountPK;
import com.echothree.model.data.accounting.common.pk.CurrencyPK;

import com.echothree.model.data.payment.server.entity.BillingAccount;
import com.echothree.model.data.accounting.server.entity.Currency;

import com.echothree.model.data.payment.server.factory.BillingAccountFactory;
import com.echothree.model.data.accounting.server.factory.CurrencyFactory;

import com.echothree.model.data.payment.common.pk.BillingAccountDetailPK;

import com.echothree.model.data.payment.server.value.BillingAccountDetailValue;

import com.echothree.model.data.payment.server.factory.BillingAccountDetailFactory;

import com.echothree.util.common.exception.PersistenceException;
import com.echothree.util.common.exception.PersistenceDatabaseException;
import com.echothree.util.common.exception.PersistenceNotNullException;
import com.echothree.util.common.exception.PersistenceReadOnlyException;

import com.echothree.util.common.persistence.BasePK;

import com.echothree.util.common.persistence.type.ByteArray;

import com.echothree.util.server.persistence.BaseEntity;
import com.echothree.util.server.persistence.EntityPermission;
import com.echothree.util.server.persistence.Session;
import com.echothree.util.server.persistence.ThreadSession;

import java.io.Serializable;

import javax.annotation.Nonnull;
import javax.annotation.Nullable;

public class BillingAccountDetail
        extends BaseEntity
        implements Serializable {
    
    private BillingAccountDetailPK _pk;
    private BillingAccountDetailValue _value;
    
    /** Creates a new instance of BillingAccountDetail */
    public BillingAccountDetail()
            throws PersistenceException {
        super();
    }
    
    /** Creates a new instance of BillingAccountDetail */
    public BillingAccountDetail(BillingAccountDetailValue value, EntityPermission entityPermission) {
        super(entityPermission);
        
        _value = value;
        _pk = value.getPrimaryKey();
    }
    
    @Override
    @Nonnull
    public BillingAccountDetailFactory getBaseFactoryInstance() {
        return BillingAccountDetailFactory.getInstance();
    }
    
    @Override
    public boolean hasBeenModified() {
        return _value.hasBeenModified();
    }
    
    @Override
    public int hashCode() {
        return _pk.hashCode();
    }
    
    @Override
    @Nonnull
    public String toString() {
        return _pk.toString();
    }
    
    @Override
    public boolean equals(Object other) {
        if(this == other)
            return true;
        
        if(other instanceof BillingAccountDetail that) {
            BillingAccountDetailValue thatValue = that.getBillingAccountDetailValue();
            return _value.equals(thatValue);
        } else {
            return false;
        }
    }
    
    @Override
    public void store()
            throws PersistenceDatabaseException {
        getBaseFactoryInstance().store(this);
    }
    
    @Override
    public void remove()
            throws PersistenceDatabaseException {
        getBaseFactoryInstance().remove(this);
    }
    
    @Nonnull
    public BillingAccountDetailValue getBillingAccountDetailValue() {
        return _value;
    }
    
    public void setBillingAccountDetailValue(@Nonnull BillingAccountDetailValue value)
            throws PersistenceReadOnlyException {
        checkReadWrite();
        _value = value;
    }
    
    @Override
    @Nonnull
    public BillingAccountDetailPK getPrimaryKey() {
        return _pk;
    }
    
    @Nonnull
    public BillingAccountPK getBillingAccountPK() {
        return _value.getBillingAccountPK();
    }
    
    @Nonnull
    public BillingAccount getBillingAccount(EntityPermission entityPermission) {
        return BillingAccountFactory.getInstance().getEntityFromPK(entityPermission, getBillingAccountPK());
    }
    
    @Nonnull
    public BillingAccount getBillingAccount() {
        return getBillingAccount(EntityPermission.READ_ONLY);
    }
    
    @Nonnull
    public BillingAccount getBillingAccountForUpdate() {
        return getBillingAccount(EntityPermission.READ_WRITE);
    }
    
    public void setBillingAccountPK(@Nonnull BillingAccountPK billingAccountPK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setBillingAccountPK(billingAccountPK);
    }
    
    public void setBillingAccount(@Nonnull BillingAccount entity) {
        setBillingAccountPK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getBillingAccountPKHasBeenModified() {
        return _value.getBillingAccountPKHasBeenModified();
    }
    
    @Nonnull
    public String getBillingAccountName() {
        return _value.getBillingAccountName();
    }
    
    public void setBillingAccountName(@Nonnull String billingAccountName)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setBillingAccountName(billingAccountName);
    }
    
    public boolean getBillingAccountNameHasBeenModified() {
        return _value.getBillingAccountNameHasBeenModified();
    }
    
    @Nonnull
    public CurrencyPK getCurrencyPK() {
        return _value.getCurrencyPK();
    }
    
    @Nonnull
    public Currency getCurrency(EntityPermission entityPermission) {
        return CurrencyFactory.getInstance().getEntityFromPK(entityPermission, getCurrencyPK());
    }
    
    @Nonnull
    public Currency getCurrency() {
        return getCurrency(EntityPermission.READ_ONLY);
    }
    
    @Nonnull
    public Currency getCurrencyForUpdate() {
        return getCurrency(EntityPermission.READ_WRITE);
    }
    
    public void setCurrencyPK(@Nonnull CurrencyPK currencyPK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setCurrencyPK(currencyPK);
    }
    
    public void setCurrency(@Nonnull Currency entity) {
        setCurrencyPK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getCurrencyPKHasBeenModified() {
        return _value.getCurrencyPKHasBeenModified();
    }
    
    @Nullable
    public String getReference() {
        return _value.getReference();
    }
    
    public void setReference(@Nullable String reference)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setReference(reference);
    }
    
    public boolean getReferenceHasBeenModified() {
        return _value.getReferenceHasBeenModified();
    }
    
    @Nullable
    public String getDescription() {
        return _value.getDescription();
    }
    
    public void setDescription(@Nullable String description)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setDescription(description);
    }
    
    public boolean getDescriptionHasBeenModified() {
        return _value.getDescriptionHasBeenModified();
    }
    
    @Nonnull
    public Long getFromTime() {
        return _value.getFromTime();
    }
    
    public void setFromTime(@Nonnull Long fromTime)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setFromTime(fromTime);
    }
    
    public boolean getFromTimeHasBeenModified() {
        return _value.getFromTimeHasBeenModified();
    }
    
    @Nonnull
    public Long getThruTime() {
        return _value.getThruTime();
    }
    
    public void setThruTime(@Nonnull Long thruTime)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setThruTime(thruTime);
    }
    
    public boolean getThruTimeHasBeenModified() {
        return _value.getThruTimeHasBeenModified();
    }
    
}