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

/**
 * Customer.java
 */

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

import com.echothree.model.data.customer.common.pk.CustomerPK;

import com.echothree.model.data.party.common.pk.PartyPK;
import com.echothree.model.data.customer.common.pk.CustomerTypePK;
import com.echothree.model.data.offer.common.pk.OfferUsePK;
import com.echothree.model.data.cancellationpolicy.common.pk.CancellationPolicyPK;
import com.echothree.model.data.returnpolicy.common.pk.ReturnPolicyPK;
import com.echothree.model.data.accounting.common.pk.GlAccountPK;

import com.echothree.model.data.party.server.entity.Party;
import com.echothree.model.data.customer.server.entity.CustomerType;
import com.echothree.model.data.offer.server.entity.OfferUse;
import com.echothree.model.data.cancellationpolicy.server.entity.CancellationPolicy;
import com.echothree.model.data.returnpolicy.server.entity.ReturnPolicy;
import com.echothree.model.data.accounting.server.entity.GlAccount;

import com.echothree.model.data.party.server.factory.PartyFactory;
import com.echothree.model.data.customer.server.factory.CustomerTypeFactory;
import com.echothree.model.data.offer.server.factory.OfferUseFactory;
import com.echothree.model.data.cancellationpolicy.server.factory.CancellationPolicyFactory;
import com.echothree.model.data.returnpolicy.server.factory.ReturnPolicyFactory;
import com.echothree.model.data.accounting.server.factory.GlAccountFactory;

import com.echothree.model.data.customer.common.pk.CustomerPK;

import com.echothree.model.data.customer.server.value.CustomerValue;

import com.echothree.model.data.customer.server.factory.CustomerFactory;

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 Customer
        extends BaseEntity
        implements Serializable {
    
    private CustomerPK _pk;
    private CustomerValue _value;
    
    /** Creates a new instance of Customer */
    public Customer()
            throws PersistenceException {
        super();
    }
    
    /** Creates a new instance of Customer */
    public Customer(CustomerValue value, EntityPermission entityPermission) {
        super(entityPermission);
        
        _value = value;
        _pk = value.getPrimaryKey();
    }
    
    @Override
    @Nonnull
    public CustomerFactory getBaseFactoryInstance() {
        return CustomerFactory.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 Customer that) {
            CustomerValue thatValue = that.getCustomerValue();
            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 CustomerValue getCustomerValue() {
        return _value;
    }
    
    public void setCustomerValue(@Nonnull CustomerValue value)
            throws PersistenceReadOnlyException {
        checkReadWrite();
        _value = value;
    }
    
    @Override
    @Nonnull
    public CustomerPK getPrimaryKey() {
        return _pk;
    }
    
    @Nonnull
    public PartyPK getPartyPK() {
        return _value.getPartyPK();
    }
    
    @Nonnull
    public Party getParty(EntityPermission entityPermission) {
        return PartyFactory.getInstance().getEntityFromPK(entityPermission, getPartyPK());
    }
    
    @Nonnull
    public Party getParty() {
        return getParty(EntityPermission.READ_ONLY);
    }
    
    @Nonnull
    public Party getPartyForUpdate() {
        return getParty(EntityPermission.READ_WRITE);
    }
    
    public void setPartyPK(@Nonnull PartyPK partyPK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setPartyPK(partyPK);
    }
    
    public void setParty(@Nonnull Party entity) {
        setPartyPK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getPartyPKHasBeenModified() {
        return _value.getPartyPKHasBeenModified();
    }
    
    @Nonnull
    public String getCustomerName() {
        return _value.getCustomerName();
    }
    
    public void setCustomerName(@Nonnull String customerName)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setCustomerName(customerName);
    }
    
    public boolean getCustomerNameHasBeenModified() {
        return _value.getCustomerNameHasBeenModified();
    }
    
    @Nonnull
    public CustomerTypePK getCustomerTypePK() {
        return _value.getCustomerTypePK();
    }
    
    @Nonnull
    public CustomerType getCustomerType(EntityPermission entityPermission) {
        return CustomerTypeFactory.getInstance().getEntityFromPK(entityPermission, getCustomerTypePK());
    }
    
    @Nonnull
    public CustomerType getCustomerType() {
        return getCustomerType(EntityPermission.READ_ONLY);
    }
    
    @Nonnull
    public CustomerType getCustomerTypeForUpdate() {
        return getCustomerType(EntityPermission.READ_WRITE);
    }
    
    public void setCustomerTypePK(@Nonnull CustomerTypePK customerTypePK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setCustomerTypePK(customerTypePK);
    }
    
    public void setCustomerType(@Nonnull CustomerType entity) {
        setCustomerTypePK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getCustomerTypePKHasBeenModified() {
        return _value.getCustomerTypePKHasBeenModified();
    }
    
    @Nonnull
    public OfferUsePK getInitialOfferUsePK() {
        return _value.getInitialOfferUsePK();
    }
    
    @Nonnull
    public OfferUse getInitialOfferUse(EntityPermission entityPermission) {
        return OfferUseFactory.getInstance().getEntityFromPK(entityPermission, getInitialOfferUsePK());
    }
    
    @Nonnull
    public OfferUse getInitialOfferUse() {
        return getInitialOfferUse(EntityPermission.READ_ONLY);
    }
    
    @Nonnull
    public OfferUse getInitialOfferUseForUpdate() {
        return getInitialOfferUse(EntityPermission.READ_WRITE);
    }
    
    public void setInitialOfferUsePK(@Nonnull OfferUsePK initialOfferUsePK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setInitialOfferUsePK(initialOfferUsePK);
    }
    
    public void setInitialOfferUse(@Nonnull OfferUse entity) {
        setInitialOfferUsePK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getInitialOfferUsePKHasBeenModified() {
        return _value.getInitialOfferUsePKHasBeenModified();
    }
    
    @Nullable
    public CancellationPolicyPK getCancellationPolicyPK() {
        return _value.getCancellationPolicyPK();
    }
    
    @Nullable
    public CancellationPolicy getCancellationPolicy(EntityPermission entityPermission) {
        CancellationPolicyPK pk = getCancellationPolicyPK();
        CancellationPolicy entity = pk == null? null: CancellationPolicyFactory.getInstance().getEntityFromPK(entityPermission, pk);
        
        return entity;
    }
    
    @Nullable
    public CancellationPolicy getCancellationPolicy() {
        return getCancellationPolicy(EntityPermission.READ_ONLY);
    }
    
    @Nullable
    public CancellationPolicy getCancellationPolicyForUpdate() {
        return getCancellationPolicy(EntityPermission.READ_WRITE);
    }
    
    public void setCancellationPolicyPK(@Nullable CancellationPolicyPK cancellationPolicyPK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setCancellationPolicyPK(cancellationPolicyPK);
    }
    
    public void setCancellationPolicy(@Nullable CancellationPolicy entity) {
        setCancellationPolicyPK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getCancellationPolicyPKHasBeenModified() {
        return _value.getCancellationPolicyPKHasBeenModified();
    }
    
    @Nullable
    public ReturnPolicyPK getReturnPolicyPK() {
        return _value.getReturnPolicyPK();
    }
    
    @Nullable
    public ReturnPolicy getReturnPolicy(EntityPermission entityPermission) {
        ReturnPolicyPK pk = getReturnPolicyPK();
        ReturnPolicy entity = pk == null? null: ReturnPolicyFactory.getInstance().getEntityFromPK(entityPermission, pk);
        
        return entity;
    }
    
    @Nullable
    public ReturnPolicy getReturnPolicy() {
        return getReturnPolicy(EntityPermission.READ_ONLY);
    }
    
    @Nullable
    public ReturnPolicy getReturnPolicyForUpdate() {
        return getReturnPolicy(EntityPermission.READ_WRITE);
    }
    
    public void setReturnPolicyPK(@Nullable ReturnPolicyPK returnPolicyPK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setReturnPolicyPK(returnPolicyPK);
    }
    
    public void setReturnPolicy(@Nullable ReturnPolicy entity) {
        setReturnPolicyPK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getReturnPolicyPKHasBeenModified() {
        return _value.getReturnPolicyPKHasBeenModified();
    }
    
    @Nullable
    public GlAccountPK getArGlAccountPK() {
        return _value.getArGlAccountPK();
    }
    
    @Nullable
    public GlAccount getArGlAccount(EntityPermission entityPermission) {
        GlAccountPK pk = getArGlAccountPK();
        GlAccount entity = pk == null? null: GlAccountFactory.getInstance().getEntityFromPK(entityPermission, pk);
        
        return entity;
    }
    
    @Nullable
    public GlAccount getArGlAccount() {
        return getArGlAccount(EntityPermission.READ_ONLY);
    }
    
    @Nullable
    public GlAccount getArGlAccountForUpdate() {
        return getArGlAccount(EntityPermission.READ_WRITE);
    }
    
    public void setArGlAccountPK(@Nullable GlAccountPK arGlAccountPK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setArGlAccountPK(arGlAccountPK);
    }
    
    public void setArGlAccount(@Nullable GlAccount entity) {
        setArGlAccountPK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getArGlAccountPKHasBeenModified() {
        return _value.getArGlAccountPKHasBeenModified();
    }
    
    @Nonnull
    public Boolean getHoldUntilComplete() {
        return _value.getHoldUntilComplete();
    }
    
    public void setHoldUntilComplete(@Nonnull Boolean holdUntilComplete)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setHoldUntilComplete(holdUntilComplete);
    }
    
    public boolean getHoldUntilCompleteHasBeenModified() {
        return _value.getHoldUntilCompleteHasBeenModified();
    }
    
    @Nonnull
    public Boolean getAllowBackorders() {
        return _value.getAllowBackorders();
    }
    
    public void setAllowBackorders(@Nonnull Boolean allowBackorders)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setAllowBackorders(allowBackorders);
    }
    
    public boolean getAllowBackordersHasBeenModified() {
        return _value.getAllowBackordersHasBeenModified();
    }
    
    @Nonnull
    public Boolean getAllowSubstitutions() {
        return _value.getAllowSubstitutions();
    }
    
    public void setAllowSubstitutions(@Nonnull Boolean allowSubstitutions)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setAllowSubstitutions(allowSubstitutions);
    }
    
    public boolean getAllowSubstitutionsHasBeenModified() {
        return _value.getAllowSubstitutionsHasBeenModified();
    }
    
    @Nonnull
    public Boolean getAllowCombiningShipments() {
        return _value.getAllowCombiningShipments();
    }
    
    public void setAllowCombiningShipments(@Nonnull Boolean allowCombiningShipments)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setAllowCombiningShipments(allowCombiningShipments);
    }
    
    public boolean getAllowCombiningShipmentsHasBeenModified() {
        return _value.getAllowCombiningShipmentsHasBeenModified();
    }
    
    @Nonnull
    public Boolean getRequireReference() {
        return _value.getRequireReference();
    }
    
    public void setRequireReference(@Nonnull Boolean requireReference)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setRequireReference(requireReference);
    }
    
    public boolean getRequireReferenceHasBeenModified() {
        return _value.getRequireReferenceHasBeenModified();
    }
    
    @Nonnull
    public Boolean getAllowReferenceDuplicates() {
        return _value.getAllowReferenceDuplicates();
    }
    
    public void setAllowReferenceDuplicates(@Nonnull Boolean allowReferenceDuplicates)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setAllowReferenceDuplicates(allowReferenceDuplicates);
    }
    
    public boolean getAllowReferenceDuplicatesHasBeenModified() {
        return _value.getAllowReferenceDuplicatesHasBeenModified();
    }
    
    @Nullable
    public String getReferenceValidationPattern() {
        return _value.getReferenceValidationPattern();
    }
    
    public void setReferenceValidationPattern(@Nullable String referenceValidationPattern)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setReferenceValidationPattern(referenceValidationPattern);
    }
    
    public boolean getReferenceValidationPatternHasBeenModified() {
        return _value.getReferenceValidationPatternHasBeenModified();
    }
    
    @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();
    }
    
}