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

/**
 * Vendor.java
 */

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

import com.echothree.model.data.vendor.common.pk.VendorPK;

import com.echothree.model.data.party.common.pk.PartyPK;
import com.echothree.model.data.vendor.common.pk.VendorTypePK;
import com.echothree.model.data.item.common.pk.ItemAliasTypePK;
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.selector.common.pk.SelectorPK;
import com.echothree.model.data.filter.common.pk.FilterPK;

import com.echothree.model.data.party.server.entity.Party;
import com.echothree.model.data.vendor.server.entity.VendorType;
import com.echothree.model.data.item.server.entity.ItemAliasType;
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.selector.server.entity.Selector;
import com.echothree.model.data.filter.server.entity.Filter;

import com.echothree.model.data.party.server.factory.PartyFactory;
import com.echothree.model.data.vendor.server.factory.VendorTypeFactory;
import com.echothree.model.data.item.server.factory.ItemAliasTypeFactory;
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.selector.server.factory.SelectorFactory;
import com.echothree.model.data.filter.server.factory.FilterFactory;

import com.echothree.model.data.vendor.common.pk.VendorPK;

import com.echothree.model.data.vendor.server.value.VendorValue;

import com.echothree.model.data.vendor.server.factory.VendorFactory;

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 Vendor
        extends BaseEntity
        implements Serializable {
    
    private VendorPK _pk;
    private VendorValue _value;
    
    /** Creates a new instance of Vendor */
    public Vendor()
            throws PersistenceException {
        super();
    }
    
    /** Creates a new instance of Vendor */
    public Vendor(VendorValue value, EntityPermission entityPermission) {
        super(entityPermission);
        
        _value = value;
        _pk = value.getPrimaryKey();
    }
    
    @Override
    @Nonnull
    public VendorFactory getBaseFactoryInstance() {
        return VendorFactory.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 Vendor that) {
            VendorValue thatValue = that.getVendorValue();
            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 VendorValue getVendorValue() {
        return _value;
    }
    
    public void setVendorValue(@Nonnull VendorValue value)
            throws PersistenceReadOnlyException {
        checkReadWrite();
        _value = value;
    }
    
    @Override
    @Nonnull
    public VendorPK 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 getVendorName() {
        return _value.getVendorName();
    }
    
    public void setVendorName(@Nonnull String vendorName)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setVendorName(vendorName);
    }
    
    public boolean getVendorNameHasBeenModified() {
        return _value.getVendorNameHasBeenModified();
    }
    
    @Nonnull
    public VendorTypePK getVendorTypePK() {
        return _value.getVendorTypePK();
    }
    
    @Nonnull
    public VendorType getVendorType(EntityPermission entityPermission) {
        return VendorTypeFactory.getInstance().getEntityFromPK(entityPermission, getVendorTypePK());
    }
    
    @Nonnull
    public VendorType getVendorType() {
        return getVendorType(EntityPermission.READ_ONLY);
    }
    
    @Nonnull
    public VendorType getVendorTypeForUpdate() {
        return getVendorType(EntityPermission.READ_WRITE);
    }
    
    public void setVendorTypePK(@Nonnull VendorTypePK vendorTypePK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setVendorTypePK(vendorTypePK);
    }
    
    public void setVendorType(@Nonnull VendorType entity) {
        setVendorTypePK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getVendorTypePKHasBeenModified() {
        return _value.getVendorTypePKHasBeenModified();
    }
    
    @Nullable
    public Integer getMinimumPurchaseOrderLines() {
        return _value.getMinimumPurchaseOrderLines();
    }
    
    public void setMinimumPurchaseOrderLines(@Nullable Integer minimumPurchaseOrderLines)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setMinimumPurchaseOrderLines(minimumPurchaseOrderLines);
    }
    
    public boolean getMinimumPurchaseOrderLinesHasBeenModified() {
        return _value.getMinimumPurchaseOrderLinesHasBeenModified();
    }
    
    @Nullable
    public Integer getMaximumPurchaseOrderLines() {
        return _value.getMaximumPurchaseOrderLines();
    }
    
    public void setMaximumPurchaseOrderLines(@Nullable Integer maximumPurchaseOrderLines)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setMaximumPurchaseOrderLines(maximumPurchaseOrderLines);
    }
    
    public boolean getMaximumPurchaseOrderLinesHasBeenModified() {
        return _value.getMaximumPurchaseOrderLinesHasBeenModified();
    }
    
    @Nullable
    public Long getMinimumPurchaseOrderAmount() {
        return _value.getMinimumPurchaseOrderAmount();
    }
    
    public void setMinimumPurchaseOrderAmount(@Nullable Long minimumPurchaseOrderAmount)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setMinimumPurchaseOrderAmount(minimumPurchaseOrderAmount);
    }
    
    public boolean getMinimumPurchaseOrderAmountHasBeenModified() {
        return _value.getMinimumPurchaseOrderAmountHasBeenModified();
    }
    
    @Nullable
    public Long getMaximumPurchaseOrderAmount() {
        return _value.getMaximumPurchaseOrderAmount();
    }
    
    public void setMaximumPurchaseOrderAmount(@Nullable Long maximumPurchaseOrderAmount)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setMaximumPurchaseOrderAmount(maximumPurchaseOrderAmount);
    }
    
    public boolean getMaximumPurchaseOrderAmountHasBeenModified() {
        return _value.getMaximumPurchaseOrderAmountHasBeenModified();
    }
    
    @Nonnull
    public Boolean getUseItemPurchasingCategories() {
        return _value.getUseItemPurchasingCategories();
    }
    
    public void setUseItemPurchasingCategories(@Nonnull Boolean useItemPurchasingCategories)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setUseItemPurchasingCategories(useItemPurchasingCategories);
    }
    
    public boolean getUseItemPurchasingCategoriesHasBeenModified() {
        return _value.getUseItemPurchasingCategoriesHasBeenModified();
    }
    
    @Nullable
    public ItemAliasTypePK getDefaultItemAliasTypePK() {
        return _value.getDefaultItemAliasTypePK();
    }
    
    @Nullable
    public ItemAliasType getDefaultItemAliasType(EntityPermission entityPermission) {
        ItemAliasTypePK pk = getDefaultItemAliasTypePK();
        ItemAliasType entity = pk == null? null: ItemAliasTypeFactory.getInstance().getEntityFromPK(entityPermission, pk);
        
        return entity;
    }
    
    @Nullable
    public ItemAliasType getDefaultItemAliasType() {
        return getDefaultItemAliasType(EntityPermission.READ_ONLY);
    }
    
    @Nullable
    public ItemAliasType getDefaultItemAliasTypeForUpdate() {
        return getDefaultItemAliasType(EntityPermission.READ_WRITE);
    }
    
    public void setDefaultItemAliasTypePK(@Nullable ItemAliasTypePK defaultItemAliasTypePK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setDefaultItemAliasTypePK(defaultItemAliasTypePK);
    }
    
    public void setDefaultItemAliasType(@Nullable ItemAliasType entity) {
        setDefaultItemAliasTypePK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getDefaultItemAliasTypePKHasBeenModified() {
        return _value.getDefaultItemAliasTypePKHasBeenModified();
    }
    
    @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 getApGlAccountPK() {
        return _value.getApGlAccountPK();
    }
    
    @Nullable
    public GlAccount getApGlAccount(EntityPermission entityPermission) {
        GlAccountPK pk = getApGlAccountPK();
        GlAccount entity = pk == null? null: GlAccountFactory.getInstance().getEntityFromPK(entityPermission, pk);
        
        return entity;
    }
    
    @Nullable
    public GlAccount getApGlAccount() {
        return getApGlAccount(EntityPermission.READ_ONLY);
    }
    
    @Nullable
    public GlAccount getApGlAccountForUpdate() {
        return getApGlAccount(EntityPermission.READ_WRITE);
    }
    
    public void setApGlAccountPK(@Nullable GlAccountPK apGlAccountPK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setApGlAccountPK(apGlAccountPK);
    }
    
    public void setApGlAccount(@Nullable GlAccount entity) {
        setApGlAccountPK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getApGlAccountPKHasBeenModified() {
        return _value.getApGlAccountPKHasBeenModified();
    }
    
    @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();
    }
    
    @Nullable
    public SelectorPK getVendorItemSelectorPK() {
        return _value.getVendorItemSelectorPK();
    }
    
    @Nullable
    public Selector getVendorItemSelector(EntityPermission entityPermission) {
        SelectorPK pk = getVendorItemSelectorPK();
        Selector entity = pk == null? null: SelectorFactory.getInstance().getEntityFromPK(entityPermission, pk);
        
        return entity;
    }
    
    @Nullable
    public Selector getVendorItemSelector() {
        return getVendorItemSelector(EntityPermission.READ_ONLY);
    }
    
    @Nullable
    public Selector getVendorItemSelectorForUpdate() {
        return getVendorItemSelector(EntityPermission.READ_WRITE);
    }
    
    public void setVendorItemSelectorPK(@Nullable SelectorPK vendorItemSelectorPK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setVendorItemSelectorPK(vendorItemSelectorPK);
    }
    
    public void setVendorItemSelector(@Nullable Selector entity) {
        setVendorItemSelectorPK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getVendorItemSelectorPKHasBeenModified() {
        return _value.getVendorItemSelectorPKHasBeenModified();
    }
    
    @Nullable
    public FilterPK getVendorItemCostFilterPK() {
        return _value.getVendorItemCostFilterPK();
    }
    
    @Nullable
    public Filter getVendorItemCostFilter(EntityPermission entityPermission) {
        FilterPK pk = getVendorItemCostFilterPK();
        Filter entity = pk == null? null: FilterFactory.getInstance().getEntityFromPK(entityPermission, pk);
        
        return entity;
    }
    
    @Nullable
    public Filter getVendorItemCostFilter() {
        return getVendorItemCostFilter(EntityPermission.READ_ONLY);
    }
    
    @Nullable
    public Filter getVendorItemCostFilterForUpdate() {
        return getVendorItemCostFilter(EntityPermission.READ_WRITE);
    }
    
    public void setVendorItemCostFilterPK(@Nullable FilterPK vendorItemCostFilterPK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setVendorItemCostFilterPK(vendorItemCostFilterPK);
    }
    
    public void setVendorItemCostFilter(@Nullable Filter entity) {
        setVendorItemCostFilterPK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getVendorItemCostFilterPKHasBeenModified() {
        return _value.getVendorItemCostFilterPKHasBeenModified();
    }
    
    @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();
    }
    
}