// --------------------------------------------------------------------------------
// 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
// --------------------------------------------------------------------------------

/**
 * PaymentDetail.java
 */

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

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

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

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

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

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

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

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

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 PaymentDetail
        extends BaseEntity
        implements Serializable {
    
    private PaymentDetailPK _pk;
    private PaymentDetailValue _value;
    
    /** Creates a new instance of PaymentDetail */
    public PaymentDetail()
            throws PersistenceException {
        super();
    }
    
    /** Creates a new instance of PaymentDetail */
    public PaymentDetail(PaymentDetailValue value, EntityPermission entityPermission) {
        super(entityPermission);
        
        _value = value;
        _pk = value.getPrimaryKey();
    }
    
    @Override
    @Nonnull
    public PaymentDetailFactory getBaseFactoryInstance() {
        return PaymentDetailFactory.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 PaymentDetail that) {
            PaymentDetailValue thatValue = that.getPaymentDetailValue();
            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 PaymentDetailValue getPaymentDetailValue() {
        return _value;
    }
    
    public void setPaymentDetailValue(@Nonnull PaymentDetailValue value)
            throws PersistenceReadOnlyException {
        checkReadWrite();
        _value = value;
    }
    
    @Override
    @Nonnull
    public PaymentDetailPK getPrimaryKey() {
        return _pk;
    }
    
    @Nonnull
    public PaymentPK getPaymentPK() {
        return _value.getPaymentPK();
    }
    
    @Nonnull
    public Payment getPayment(EntityPermission entityPermission) {
        return PaymentFactory.getInstance().getEntityFromPK(entityPermission, getPaymentPK());
    }
    
    @Nonnull
    public Payment getPayment() {
        return getPayment(EntityPermission.READ_ONLY);
    }
    
    @Nonnull
    public Payment getPaymentForUpdate() {
        return getPayment(EntityPermission.READ_WRITE);
    }
    
    public void setPaymentPK(@Nonnull PaymentPK paymentPK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setPaymentPK(paymentPK);
    }
    
    public void setPayment(@Nonnull Payment entity) {
        setPaymentPK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getPaymentPKHasBeenModified() {
        return _value.getPaymentPKHasBeenModified();
    }
    
    @Nonnull
    public String getPaymentName() {
        return _value.getPaymentName();
    }
    
    public void setPaymentName(@Nonnull String paymentName)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setPaymentName(paymentName);
    }
    
    public boolean getPaymentNameHasBeenModified() {
        return _value.getPaymentNameHasBeenModified();
    }
    
    @Nullable
    public PartyPaymentMethodPK getPartyPaymentMethodPK() {
        return _value.getPartyPaymentMethodPK();
    }
    
    @Nullable
    public PartyPaymentMethod getPartyPaymentMethod(EntityPermission entityPermission) {
        PartyPaymentMethodPK pk = getPartyPaymentMethodPK();
        PartyPaymentMethod entity = pk == null? null: PartyPaymentMethodFactory.getInstance().getEntityFromPK(entityPermission, pk);
        
        return entity;
    }
    
    @Nullable
    public PartyPaymentMethod getPartyPaymentMethod() {
        return getPartyPaymentMethod(EntityPermission.READ_ONLY);
    }
    
    @Nullable
    public PartyPaymentMethod getPartyPaymentMethodForUpdate() {
        return getPartyPaymentMethod(EntityPermission.READ_WRITE);
    }
    
    public void setPartyPaymentMethodPK(@Nullable PartyPaymentMethodPK partyPaymentMethodPK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setPartyPaymentMethodPK(partyPaymentMethodPK);
    }
    
    public void setPartyPaymentMethod(@Nullable PartyPaymentMethod entity) {
        setPartyPaymentMethodPK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getPartyPaymentMethodPKHasBeenModified() {
        return _value.getPartyPaymentMethodPKHasBeenModified();
    }
    
    @Nullable
    public CurrencyPK getCurrencyPK() {
        return _value.getCurrencyPK();
    }
    
    @Nullable
    public Currency getCurrency(EntityPermission entityPermission) {
        CurrencyPK pk = getCurrencyPK();
        Currency entity = pk == null? null: CurrencyFactory.getInstance().getEntityFromPK(entityPermission, pk);
        
        return entity;
    }
    
    @Nullable
    public Currency getCurrency() {
        return getCurrency(EntityPermission.READ_ONLY);
    }
    
    @Nullable
    public Currency getCurrencyForUpdate() {
        return getCurrency(EntityPermission.READ_WRITE);
    }
    
    public void setCurrencyPK(@Nullable CurrencyPK currencyPK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setCurrencyPK(currencyPK);
    }
    
    public void setCurrency(@Nullable Currency entity) {
        setCurrencyPK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getCurrencyPKHasBeenModified() {
        return _value.getCurrencyPKHasBeenModified();
    }
    
    @Nonnull
    public Long getAmount() {
        return _value.getAmount();
    }
    
    public void setAmount(@Nonnull Long amount)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setAmount(amount);
    }
    
    public boolean getAmountHasBeenModified() {
        return _value.getAmountHasBeenModified();
    }
    
    @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();
    }
    
}