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

/**
 * GlAccountSummary.java
 */

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

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

import com.echothree.model.data.accounting.common.pk.GlAccountPK;
import com.echothree.model.data.party.common.pk.PartyPK;
import com.echothree.model.data.period.common.pk.PeriodPK;

import com.echothree.model.data.accounting.server.entity.GlAccount;
import com.echothree.model.data.party.server.entity.Party;
import com.echothree.model.data.period.server.entity.Period;

import com.echothree.model.data.accounting.server.factory.GlAccountFactory;
import com.echothree.model.data.party.server.factory.PartyFactory;
import com.echothree.model.data.period.server.factory.PeriodFactory;

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

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

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

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 GlAccountSummary
        extends BaseEntity
        implements Serializable {
    
    private GlAccountSummaryPK _pk;
    private GlAccountSummaryValue _value;
    
    /** Creates a new instance of GlAccountSummary */
    public GlAccountSummary()
            throws PersistenceException {
        super();
    }
    
    /** Creates a new instance of GlAccountSummary */
    public GlAccountSummary(GlAccountSummaryValue value, EntityPermission entityPermission) {
        super(entityPermission);
        
        _value = value;
        _pk = value.getPrimaryKey();
    }
    
    @Override
    @Nonnull
    public GlAccountSummaryFactory getBaseFactoryInstance() {
        return GlAccountSummaryFactory.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 GlAccountSummary that) {
            GlAccountSummaryValue thatValue = that.getGlAccountSummaryValue();
            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 GlAccountSummaryValue getGlAccountSummaryValue() {
        return _value;
    }
    
    public void setGlAccountSummaryValue(@Nonnull GlAccountSummaryValue value)
            throws PersistenceReadOnlyException {
        checkReadWrite();
        _value = value;
    }
    
    @Override
    @Nonnull
    public GlAccountSummaryPK getPrimaryKey() {
        return _pk;
    }
    
    @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 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();
    }
    
    @Nonnull
    public PeriodPK getPeriodPK() {
        return _value.getPeriodPK();
    }
    
    @Nonnull
    public Period getPeriod(EntityPermission entityPermission) {
        return PeriodFactory.getInstance().getEntityFromPK(entityPermission, getPeriodPK());
    }
    
    @Nonnull
    public Period getPeriod() {
        return getPeriod(EntityPermission.READ_ONLY);
    }
    
    @Nonnull
    public Period getPeriodForUpdate() {
        return getPeriod(EntityPermission.READ_WRITE);
    }
    
    public void setPeriodPK(@Nonnull PeriodPK periodPK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setPeriodPK(periodPK);
    }
    
    public void setPeriod(@Nonnull Period entity) {
        setPeriodPK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getPeriodPKHasBeenModified() {
        return _value.getPeriodPKHasBeenModified();
    }
    
    @Nonnull
    public Long getDebitTotal() {
        return _value.getDebitTotal();
    }
    
    public void setDebitTotal(@Nonnull Long debitTotal)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setDebitTotal(debitTotal);
    }
    
    public boolean getDebitTotalHasBeenModified() {
        return _value.getDebitTotalHasBeenModified();
    }
    
    @Nonnull
    public Long getCreditTotal() {
        return _value.getCreditTotal();
    }
    
    public void setCreditTotal(@Nonnull Long creditTotal)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setCreditTotal(creditTotal);
    }
    
    public boolean getCreditTotalHasBeenModified() {
        return _value.getCreditTotalHasBeenModified();
    }
    
    @Nonnull
    public Long getBalance() {
        return _value.getBalance();
    }
    
    public void setBalance(@Nonnull Long balance)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setBalance(balance);
    }
    
    public boolean getBalanceHasBeenModified() {
        return _value.getBalanceHasBeenModified();
    }
    
}