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

/**
 * TransactionGlEntry.java
 */

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

import com.echothree.model.data.accounting.common.pk.TransactionGlEntryPK;

import com.echothree.model.data.accounting.common.pk.TransactionPK;
import com.echothree.model.data.party.common.pk.PartyPK;
import com.echothree.model.data.accounting.common.pk.TransactionGlAccountCategoryPK;
import com.echothree.model.data.accounting.common.pk.GlAccountPK;
import com.echothree.model.data.accounting.common.pk.CurrencyPK;

import com.echothree.model.data.accounting.server.entity.Transaction;
import com.echothree.model.data.party.server.entity.Party;
import com.echothree.model.data.accounting.server.entity.TransactionGlAccountCategory;
import com.echothree.model.data.accounting.server.entity.GlAccount;
import com.echothree.model.data.accounting.server.entity.Currency;

import com.echothree.model.data.accounting.server.factory.TransactionFactory;
import com.echothree.model.data.party.server.factory.PartyFactory;
import com.echothree.model.data.accounting.server.factory.TransactionGlAccountCategoryFactory;
import com.echothree.model.data.accounting.server.factory.GlAccountFactory;
import com.echothree.model.data.accounting.server.factory.CurrencyFactory;

import com.echothree.model.data.accounting.common.pk.TransactionGlEntryPK;

import com.echothree.model.data.accounting.server.value.TransactionGlEntryValue;

import com.echothree.model.data.accounting.server.factory.TransactionGlEntryFactory;

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 TransactionGlEntry
        extends BaseEntity
        implements Serializable {
    
    private TransactionGlEntryPK _pk;
    private TransactionGlEntryValue _value;
    
    /** Creates a new instance of TransactionGlEntry */
    public TransactionGlEntry()
            throws PersistenceException {
        super();
    }
    
    /** Creates a new instance of TransactionGlEntry */
    public TransactionGlEntry(TransactionGlEntryValue value, EntityPermission entityPermission) {
        super(entityPermission);
        
        _value = value;
        _pk = value.getPrimaryKey();
    }
    
    @Override
    @Nonnull
    public TransactionGlEntryFactory getBaseFactoryInstance() {
        return TransactionGlEntryFactory.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 TransactionGlEntry that) {
            TransactionGlEntryValue thatValue = that.getTransactionGlEntryValue();
            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 TransactionGlEntryValue getTransactionGlEntryValue() {
        return _value;
    }
    
    public void setTransactionGlEntryValue(@Nonnull TransactionGlEntryValue value)
            throws PersistenceReadOnlyException {
        checkReadWrite();
        _value = value;
    }
    
    @Override
    @Nonnull
    public TransactionGlEntryPK getPrimaryKey() {
        return _pk;
    }
    
    @Nonnull
    public TransactionPK getTransactionPK() {
        return _value.getTransactionPK();
    }
    
    @Nonnull
    public Transaction getTransaction(EntityPermission entityPermission) {
        return TransactionFactory.getInstance().getEntityFromPK(entityPermission, getTransactionPK());
    }
    
    @Nonnull
    public Transaction getTransaction() {
        return getTransaction(EntityPermission.READ_ONLY);
    }
    
    @Nonnull
    public Transaction getTransactionForUpdate() {
        return getTransaction(EntityPermission.READ_WRITE);
    }
    
    public void setTransactionPK(@Nonnull TransactionPK transactionPK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setTransactionPK(transactionPK);
    }
    
    public void setTransaction(@Nonnull Transaction entity) {
        setTransactionPK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getTransactionPKHasBeenModified() {
        return _value.getTransactionPKHasBeenModified();
    }
    
    @Nonnull
    public Integer getTransactionGlEntrySequence() {
        return _value.getTransactionGlEntrySequence();
    }
    
    public void setTransactionGlEntrySequence(@Nonnull Integer transactionGlEntrySequence)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setTransactionGlEntrySequence(transactionGlEntrySequence);
    }
    
    public boolean getTransactionGlEntrySequenceHasBeenModified() {
        return _value.getTransactionGlEntrySequenceHasBeenModified();
    }
    
    @Nonnull
    public PartyPK getGroupPartyPK() {
        return _value.getGroupPartyPK();
    }
    
    @Nonnull
    public Party getGroupParty(EntityPermission entityPermission) {
        return PartyFactory.getInstance().getEntityFromPK(entityPermission, getGroupPartyPK());
    }
    
    @Nonnull
    public Party getGroupParty() {
        return getGroupParty(EntityPermission.READ_ONLY);
    }
    
    @Nonnull
    public Party getGroupPartyForUpdate() {
        return getGroupParty(EntityPermission.READ_WRITE);
    }
    
    public void setGroupPartyPK(@Nonnull PartyPK groupPartyPK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setGroupPartyPK(groupPartyPK);
    }
    
    public void setGroupParty(@Nonnull Party entity) {
        setGroupPartyPK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getGroupPartyPKHasBeenModified() {
        return _value.getGroupPartyPKHasBeenModified();
    }
    
    @Nullable
    public TransactionGlAccountCategoryPK getTransactionGlAccountCategoryPK() {
        return _value.getTransactionGlAccountCategoryPK();
    }
    
    @Nullable
    public TransactionGlAccountCategory getTransactionGlAccountCategory(EntityPermission entityPermission) {
        TransactionGlAccountCategoryPK pk = getTransactionGlAccountCategoryPK();
        TransactionGlAccountCategory entity = pk == null? null: TransactionGlAccountCategoryFactory.getInstance().getEntityFromPK(entityPermission, pk);
        
        return entity;
    }
    
    @Nullable
    public TransactionGlAccountCategory getTransactionGlAccountCategory() {
        return getTransactionGlAccountCategory(EntityPermission.READ_ONLY);
    }
    
    @Nullable
    public TransactionGlAccountCategory getTransactionGlAccountCategoryForUpdate() {
        return getTransactionGlAccountCategory(EntityPermission.READ_WRITE);
    }
    
    public void setTransactionGlAccountCategoryPK(@Nullable TransactionGlAccountCategoryPK transactionGlAccountCategoryPK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setTransactionGlAccountCategoryPK(transactionGlAccountCategoryPK);
    }
    
    public void setTransactionGlAccountCategory(@Nullable TransactionGlAccountCategory entity) {
        setTransactionGlAccountCategoryPK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getTransactionGlAccountCategoryPKHasBeenModified() {
        return _value.getTransactionGlAccountCategoryPKHasBeenModified();
    }
    
    @Nonnull
    public GlAccountPK getGlAccountPK() {
        return _value.getGlAccountPK();
    }
    
    @Nonnull
    public GlAccount getGlAccount(EntityPermission entityPermission) {
        return GlAccountFactory.getInstance().getEntityFromPK(entityPermission, getGlAccountPK());
    }
    
    @Nonnull
    public GlAccount getGlAccount() {
        return getGlAccount(EntityPermission.READ_ONLY);
    }
    
    @Nonnull
    public GlAccount getGlAccountForUpdate() {
        return getGlAccount(EntityPermission.READ_WRITE);
    }
    
    public void setGlAccountPK(@Nonnull GlAccountPK glAccountPK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setGlAccountPK(glAccountPK);
    }
    
    public void setGlAccount(@Nonnull GlAccount entity) {
        setGlAccountPK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getGlAccountPKHasBeenModified() {
        return _value.getGlAccountPKHasBeenModified();
    }
    
    @Nonnull
    public CurrencyPK getOriginalCurrencyPK() {
        return _value.getOriginalCurrencyPK();
    }
    
    @Nonnull
    public Currency getOriginalCurrency(EntityPermission entityPermission) {
        return CurrencyFactory.getInstance().getEntityFromPK(entityPermission, getOriginalCurrencyPK());
    }
    
    @Nonnull
    public Currency getOriginalCurrency() {
        return getOriginalCurrency(EntityPermission.READ_ONLY);
    }
    
    @Nonnull
    public Currency getOriginalCurrencyForUpdate() {
        return getOriginalCurrency(EntityPermission.READ_WRITE);
    }
    
    public void setOriginalCurrencyPK(@Nonnull CurrencyPK originalCurrencyPK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setOriginalCurrencyPK(originalCurrencyPK);
    }
    
    public void setOriginalCurrency(@Nonnull Currency entity) {
        setOriginalCurrencyPK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getOriginalCurrencyPKHasBeenModified() {
        return _value.getOriginalCurrencyPKHasBeenModified();
    }
    
    @Nullable
    public Long getOriginalDebit() {
        return _value.getOriginalDebit();
    }
    
    public void setOriginalDebit(@Nullable Long originalDebit)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setOriginalDebit(originalDebit);
    }
    
    public boolean getOriginalDebitHasBeenModified() {
        return _value.getOriginalDebitHasBeenModified();
    }
    
    @Nullable
    public Long getOriginalCredit() {
        return _value.getOriginalCredit();
    }
    
    public void setOriginalCredit(@Nullable Long originalCredit)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setOriginalCredit(originalCredit);
    }
    
    public boolean getOriginalCreditHasBeenModified() {
        return _value.getOriginalCreditHasBeenModified();
    }
    
    @Nullable
    public Long getDebit() {
        return _value.getDebit();
    }
    
    public void setDebit(@Nullable Long debit)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setDebit(debit);
    }
    
    public boolean getDebitHasBeenModified() {
        return _value.getDebitHasBeenModified();
    }
    
    @Nullable
    public Long getCredit() {
        return _value.getCredit();
    }
    
    public void setCredit(@Nullable Long credit)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setCredit(credit);
    }
    
    public boolean getCreditHasBeenModified() {
        return _value.getCreditHasBeenModified();
    }
    
    @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();
    }
    
}