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

/**
 * PaymentApplicationDetail.java
 */

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

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

import com.echothree.model.data.payment.common.pk.PaymentApplicationPK;
import com.echothree.model.data.payment.common.pk.PaymentPK;
import com.echothree.model.data.invoice.common.pk.InvoiceLinePK;

import com.echothree.model.data.payment.server.entity.PaymentApplication;
import com.echothree.model.data.payment.server.entity.Payment;
import com.echothree.model.data.invoice.server.entity.InvoiceLine;

import com.echothree.model.data.payment.server.factory.PaymentApplicationFactory;
import com.echothree.model.data.payment.server.factory.PaymentFactory;
import com.echothree.model.data.invoice.server.factory.InvoiceLineFactory;

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

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

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

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;

public class PaymentApplicationDetail
        extends BaseEntity
        implements Serializable {
    
    private PaymentApplicationDetailPK _pk;
    private PaymentApplicationDetailValue _value;
    
    /** Creates a new instance of PaymentApplicationDetail */
    public PaymentApplicationDetail()
            throws PersistenceException {
        super();
    }
    
    /** Creates a new instance of PaymentApplicationDetail */
    public PaymentApplicationDetail(PaymentApplicationDetailValue value, EntityPermission entityPermission) {
        super(entityPermission);
        
        _value = value;
        _pk = value.getPrimaryKey();
    }
    
    @Override
    public PaymentApplicationDetailFactory getBaseFactoryInstance() {
        return PaymentApplicationDetailFactory.getInstance();
    }
    
    @Override
    public boolean hasBeenModified() {
        return _value.hasBeenModified();
    }
    
    @Override
    public int hashCode() {
        return _pk.hashCode();
    }
    
    @Override
    public String toString() {
        return _pk.toString();
    }
    
    @Override
    public boolean equals(Object other) {
        if(this == other)
            return true;
        
        if(other instanceof PaymentApplicationDetail that) {
            PaymentApplicationDetailValue thatValue = that.getPaymentApplicationDetailValue();
            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);
    }
    
    public PaymentApplicationDetailValue getPaymentApplicationDetailValue() {
        return _value;
    }
    
    public void setPaymentApplicationDetailValue(PaymentApplicationDetailValue value)
            throws PersistenceReadOnlyException {
        checkReadWrite();
        _value = value;
    }
    
    @Override
    public PaymentApplicationDetailPK getPrimaryKey() {
        return _pk;
    }
    
    public PaymentApplicationPK getPaymentApplicationPK() {
        return _value.getPaymentApplicationPK();
    }
    
    public PaymentApplication getPaymentApplication(EntityPermission entityPermission) {
        return PaymentApplicationFactory.getInstance().getEntityFromPK(entityPermission, getPaymentApplicationPK());
    }
    
    public PaymentApplication getPaymentApplication() {
        return getPaymentApplication(EntityPermission.READ_ONLY);
    }
    
    public PaymentApplication getPaymentApplicationForUpdate() {
        return getPaymentApplication(EntityPermission.READ_WRITE);
    }
    
    public void setPaymentApplicationPK(PaymentApplicationPK paymentApplicationPK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setPaymentApplicationPK(paymentApplicationPK);
    }
    
    public void setPaymentApplication(PaymentApplication entity) {
        setPaymentApplicationPK(entity == null? null: entity.getPrimaryKey());
    }
    
    public boolean getPaymentApplicationPKHasBeenModified() {
        return _value.getPaymentApplicationPKHasBeenModified();
    }
    
    public PaymentPK getPaymentPK() {
        return _value.getPaymentPK();
    }
    
    public Payment getPayment(EntityPermission entityPermission) {
        return PaymentFactory.getInstance().getEntityFromPK(entityPermission, getPaymentPK());
    }
    
    public Payment getPayment() {
        return getPayment(EntityPermission.READ_ONLY);
    }
    
    public Payment getPaymentForUpdate() {
        return getPayment(EntityPermission.READ_WRITE);
    }
    
    public void setPaymentPK(PaymentPK paymentPK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setPaymentPK(paymentPK);
    }
    
    public void setPayment(Payment entity) {
        setPaymentPK(entity == null? null: entity.getPrimaryKey());
    }
    
    public boolean getPaymentPKHasBeenModified() {
        return _value.getPaymentPKHasBeenModified();
    }
    
    public InvoiceLinePK getInvoiceLinePK() {
        return _value.getInvoiceLinePK();
    }
    
    public InvoiceLine getInvoiceLine(EntityPermission entityPermission) {
        return InvoiceLineFactory.getInstance().getEntityFromPK(entityPermission, getInvoiceLinePK());
    }
    
    public InvoiceLine getInvoiceLine() {
        return getInvoiceLine(EntityPermission.READ_ONLY);
    }
    
    public InvoiceLine getInvoiceLineForUpdate() {
        return getInvoiceLine(EntityPermission.READ_WRITE);
    }
    
    public void setInvoiceLinePK(InvoiceLinePK invoiceLinePK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setInvoiceLinePK(invoiceLinePK);
    }
    
    public void setInvoiceLine(InvoiceLine entity) {
        setInvoiceLinePK(entity == null? null: entity.getPrimaryKey());
    }
    
    public boolean getInvoiceLinePKHasBeenModified() {
        return _value.getInvoiceLinePKHasBeenModified();
    }
    
    public Long getAmount() {
        return _value.getAmount();
    }
    
    public void setAmount(Long amount)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setAmount(amount);
    }
    
    public boolean getAmountHasBeenModified() {
        return _value.getAmountHasBeenModified();
    }
    
    public Long getFromTime() {
        return _value.getFromTime();
    }
    
    public void setFromTime(Long fromTime)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setFromTime(fromTime);
    }
    
    public boolean getFromTimeHasBeenModified() {
        return _value.getFromTimeHasBeenModified();
    }
    
    public Long getThruTime() {
        return _value.getThruTime();
    }
    
    public void setThruTime(Long thruTime)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setThruTime(thruTime);
    }
    
    public boolean getThruTimeHasBeenModified() {
        return _value.getThruTimeHasBeenModified();
    }
    
}