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

/**
 * PaymentDeductionDetail.java
 */

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

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

import com.echothree.model.data.payment.common.pk.PaymentDeductionPK;
import com.echothree.model.data.payment.common.pk.PaymentDeductionTypePK;
import com.echothree.model.data.payment.common.pk.PaymentPK;

import com.echothree.model.data.payment.server.entity.PaymentDeduction;
import com.echothree.model.data.payment.server.entity.PaymentDeductionType;
import com.echothree.model.data.payment.server.entity.Payment;

import com.echothree.model.data.payment.server.factory.PaymentDeductionFactory;
import com.echothree.model.data.payment.server.factory.PaymentDeductionTypeFactory;
import com.echothree.model.data.payment.server.factory.PaymentFactory;

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

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

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

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 PaymentDeductionDetail
        extends BaseEntity
        implements Serializable {
    
    private PaymentDeductionDetailPK _pk;
    private PaymentDeductionDetailValue _value;
    
    /** Creates a new instance of PaymentDeductionDetail */
    public PaymentDeductionDetail()
            throws PersistenceException {
        super();
    }
    
    /** Creates a new instance of PaymentDeductionDetail */
    public PaymentDeductionDetail(PaymentDeductionDetailValue value, EntityPermission entityPermission) {
        super(entityPermission);
        
        _value = value;
        _pk = value.getPrimaryKey();
    }
    
    @Override
    @Nonnull
    public PaymentDeductionDetailFactory getBaseFactoryInstance() {
        return PaymentDeductionDetailFactory.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 PaymentDeductionDetail that) {
            PaymentDeductionDetailValue thatValue = that.getPaymentDeductionDetailValue();
            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 PaymentDeductionDetailValue getPaymentDeductionDetailValue() {
        return _value;
    }
    
    public void setPaymentDeductionDetailValue(@Nonnull PaymentDeductionDetailValue value)
            throws PersistenceReadOnlyException {
        checkReadWrite();
        _value = value;
    }
    
    @Override
    @Nonnull
    public PaymentDeductionDetailPK getPrimaryKey() {
        return _pk;
    }
    
    @Nonnull
    public PaymentDeductionPK getPaymentDeductionPK() {
        return _value.getPaymentDeductionPK();
    }
    
    @Nonnull
    public PaymentDeduction getPaymentDeduction(EntityPermission entityPermission) {
        return PaymentDeductionFactory.getInstance().getEntityFromPK(entityPermission, getPaymentDeductionPK());
    }
    
    @Nonnull
    public PaymentDeduction getPaymentDeduction() {
        return getPaymentDeduction(EntityPermission.READ_ONLY);
    }
    
    @Nonnull
    public PaymentDeduction getPaymentDeductionForUpdate() {
        return getPaymentDeduction(EntityPermission.READ_WRITE);
    }
    
    public void setPaymentDeductionPK(@Nonnull PaymentDeductionPK paymentDeductionPK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setPaymentDeductionPK(paymentDeductionPK);
    }
    
    public void setPaymentDeduction(@Nonnull PaymentDeduction entity) {
        setPaymentDeductionPK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getPaymentDeductionPKHasBeenModified() {
        return _value.getPaymentDeductionPKHasBeenModified();
    }
    
    @Nonnull
    public String getPaymentDeductionName() {
        return _value.getPaymentDeductionName();
    }
    
    public void setPaymentDeductionName(@Nonnull String paymentDeductionName)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setPaymentDeductionName(paymentDeductionName);
    }
    
    public boolean getPaymentDeductionNameHasBeenModified() {
        return _value.getPaymentDeductionNameHasBeenModified();
    }
    
    @Nullable
    public PaymentDeductionTypePK getPaymentDeductionTypePK() {
        return _value.getPaymentDeductionTypePK();
    }
    
    @Nullable
    public PaymentDeductionType getPaymentDeductionType(EntityPermission entityPermission) {
        PaymentDeductionTypePK pk = getPaymentDeductionTypePK();
        PaymentDeductionType entity = pk == null? null: PaymentDeductionTypeFactory.getInstance().getEntityFromPK(entityPermission, pk);
        
        return entity;
    }
    
    @Nullable
    public PaymentDeductionType getPaymentDeductionType() {
        return getPaymentDeductionType(EntityPermission.READ_ONLY);
    }
    
    @Nullable
    public PaymentDeductionType getPaymentDeductionTypeForUpdate() {
        return getPaymentDeductionType(EntityPermission.READ_WRITE);
    }
    
    public void setPaymentDeductionTypePK(@Nullable PaymentDeductionTypePK paymentDeductionTypePK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setPaymentDeductionTypePK(paymentDeductionTypePK);
    }
    
    public void setPaymentDeductionType(@Nullable PaymentDeductionType entity) {
        setPaymentDeductionTypePK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getPaymentDeductionTypePKHasBeenModified() {
        return _value.getPaymentDeductionTypePKHasBeenModified();
    }
    
    @Nullable
    public PaymentPK getPaymentPK() {
        return _value.getPaymentPK();
    }
    
    @Nullable
    public Payment getPayment(EntityPermission entityPermission) {
        PaymentPK pk = getPaymentPK();
        Payment entity = pk == null? null: PaymentFactory.getInstance().getEntityFromPK(entityPermission, pk);
        
        return entity;
    }
    
    @Nullable
    public Payment getPayment() {
        return getPayment(EntityPermission.READ_ONLY);
    }
    
    @Nullable
    public Payment getPaymentForUpdate() {
        return getPayment(EntityPermission.READ_WRITE);
    }
    
    public void setPaymentPK(@Nullable PaymentPK paymentPK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setPaymentPK(paymentPK);
    }
    
    public void setPayment(@Nullable Payment entity) {
        setPaymentPK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getPaymentPKHasBeenModified() {
        return _value.getPaymentPKHasBeenModified();
    }
    
    @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();
    }
    
}