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

/**
 * ItemAdditionalCharge.java
 */

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

import com.echothree.model.data.item.common.pk.ItemAdditionalChargePK;

import com.echothree.model.data.item.common.pk.ItemPK;
import com.echothree.model.data.item.common.pk.ItemAdditionalChargeTypePK;
import com.echothree.model.data.uom.common.pk.UnitOfMeasureTypePK;
import com.echothree.model.data.accounting.common.pk.CurrencyPK;

import com.echothree.model.data.item.server.entity.Item;
import com.echothree.model.data.item.server.entity.ItemAdditionalChargeType;
import com.echothree.model.data.uom.server.entity.UnitOfMeasureType;
import com.echothree.model.data.accounting.server.entity.Currency;

import com.echothree.model.data.item.server.factory.ItemFactory;
import com.echothree.model.data.item.server.factory.ItemAdditionalChargeTypeFactory;
import com.echothree.model.data.uom.server.factory.UnitOfMeasureTypeFactory;
import com.echothree.model.data.accounting.server.factory.CurrencyFactory;

import com.echothree.model.data.item.common.pk.ItemAdditionalChargePK;

import com.echothree.model.data.item.server.value.ItemAdditionalChargeValue;

import com.echothree.model.data.item.server.factory.ItemAdditionalChargeFactory;

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 ItemAdditionalCharge
        extends BaseEntity
        implements Serializable {
    
    private ItemAdditionalChargePK _pk;
    private ItemAdditionalChargeValue _value;
    
    /** Creates a new instance of ItemAdditionalCharge */
    public ItemAdditionalCharge()
            throws PersistenceException {
        super();
    }
    
    /** Creates a new instance of ItemAdditionalCharge */
    public ItemAdditionalCharge(ItemAdditionalChargeValue value, EntityPermission entityPermission) {
        super(entityPermission);
        
        _value = value;
        _pk = value.getPrimaryKey();
    }
    
    @Override
    @Nonnull
    public ItemAdditionalChargeFactory getBaseFactoryInstance() {
        return ItemAdditionalChargeFactory.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 ItemAdditionalCharge that) {
            ItemAdditionalChargeValue thatValue = that.getItemAdditionalChargeValue();
            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 ItemAdditionalChargeValue getItemAdditionalChargeValue() {
        return _value;
    }
    
    public void setItemAdditionalChargeValue(@Nonnull ItemAdditionalChargeValue value)
            throws PersistenceReadOnlyException {
        checkReadWrite();
        _value = value;
    }
    
    @Override
    @Nonnull
    public ItemAdditionalChargePK getPrimaryKey() {
        return _pk;
    }
    
    @Nonnull
    public ItemPK getItemPK() {
        return _value.getItemPK();
    }
    
    @Nonnull
    public Item getItem(EntityPermission entityPermission) {
        return ItemFactory.getInstance().getEntityFromPK(entityPermission, getItemPK());
    }
    
    @Nonnull
    public Item getItem() {
        return getItem(EntityPermission.READ_ONLY);
    }
    
    @Nonnull
    public Item getItemForUpdate() {
        return getItem(EntityPermission.READ_WRITE);
    }
    
    public void setItemPK(@Nonnull ItemPK itemPK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setItemPK(itemPK);
    }
    
    public void setItem(@Nonnull Item entity) {
        setItemPK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getItemPKHasBeenModified() {
        return _value.getItemPKHasBeenModified();
    }
    
    @Nonnull
    public ItemAdditionalChargeTypePK getItemAdditionalChargeTypePK() {
        return _value.getItemAdditionalChargeTypePK();
    }
    
    @Nonnull
    public ItemAdditionalChargeType getItemAdditionalChargeType(EntityPermission entityPermission) {
        return ItemAdditionalChargeTypeFactory.getInstance().getEntityFromPK(entityPermission, getItemAdditionalChargeTypePK());
    }
    
    @Nonnull
    public ItemAdditionalChargeType getItemAdditionalChargeType() {
        return getItemAdditionalChargeType(EntityPermission.READ_ONLY);
    }
    
    @Nonnull
    public ItemAdditionalChargeType getItemAdditionalChargeTypeForUpdate() {
        return getItemAdditionalChargeType(EntityPermission.READ_WRITE);
    }
    
    public void setItemAdditionalChargeTypePK(@Nonnull ItemAdditionalChargeTypePK itemAdditionalChargeTypePK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setItemAdditionalChargeTypePK(itemAdditionalChargeTypePK);
    }
    
    public void setItemAdditionalChargeType(@Nonnull ItemAdditionalChargeType entity) {
        setItemAdditionalChargeTypePK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getItemAdditionalChargeTypePKHasBeenModified() {
        return _value.getItemAdditionalChargeTypePKHasBeenModified();
    }
    
    @Nullable
    public UnitOfMeasureTypePK getUnitOfMeasureTypePK() {
        return _value.getUnitOfMeasureTypePK();
    }
    
    @Nullable
    public UnitOfMeasureType getUnitOfMeasureType(EntityPermission entityPermission) {
        UnitOfMeasureTypePK pk = getUnitOfMeasureTypePK();
        UnitOfMeasureType entity = pk == null? null: UnitOfMeasureTypeFactory.getInstance().getEntityFromPK(entityPermission, pk);
        
        return entity;
    }
    
    @Nullable
    public UnitOfMeasureType getUnitOfMeasureType() {
        return getUnitOfMeasureType(EntityPermission.READ_ONLY);
    }
    
    @Nullable
    public UnitOfMeasureType getUnitOfMeasureTypeForUpdate() {
        return getUnitOfMeasureType(EntityPermission.READ_WRITE);
    }
    
    public void setUnitOfMeasureTypePK(@Nullable UnitOfMeasureTypePK unitOfMeasureTypePK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setUnitOfMeasureTypePK(unitOfMeasureTypePK);
    }
    
    public void setUnitOfMeasureType(@Nullable UnitOfMeasureType entity) {
        setUnitOfMeasureTypePK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getUnitOfMeasureTypePKHasBeenModified() {
        return _value.getUnitOfMeasureTypePKHasBeenModified();
    }
    
    @Nullable
    public Long getMinimumQuantity() {
        return _value.getMinimumQuantity();
    }
    
    public void setMinimumQuantity(@Nullable Long minimumQuantity)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setMinimumQuantity(minimumQuantity);
    }
    
    public boolean getMinimumQuantityHasBeenModified() {
        return _value.getMinimumQuantityHasBeenModified();
    }
    
    @Nullable
    public Long getMaximumQuantity() {
        return _value.getMaximumQuantity();
    }
    
    public void setMaximumQuantity(@Nullable Long maximumQuantity)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setMaximumQuantity(maximumQuantity);
    }
    
    public boolean getMaximumQuantityHasBeenModified() {
        return _value.getMaximumQuantityHasBeenModified();
    }
    
    @Nonnull
    public CurrencyPK getCurrencyPK() {
        return _value.getCurrencyPK();
    }
    
    @Nonnull
    public Currency getCurrency(EntityPermission entityPermission) {
        return CurrencyFactory.getInstance().getEntityFromPK(entityPermission, getCurrencyPK());
    }
    
    @Nonnull
    public Currency getCurrency() {
        return getCurrency(EntityPermission.READ_ONLY);
    }
    
    @Nonnull
    public Currency getCurrencyForUpdate() {
        return getCurrency(EntityPermission.READ_WRITE);
    }
    
    public void setCurrencyPK(@Nonnull CurrencyPK currencyPK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setCurrencyPK(currencyPK);
    }
    
    public void setCurrency(@Nonnull Currency entity) {
        setCurrencyPK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getCurrencyPKHasBeenModified() {
        return _value.getCurrencyPKHasBeenModified();
    }
    
    @Nonnull
    public Long getUnitPrice() {
        return _value.getUnitPrice();
    }
    
    public void setUnitPrice(@Nonnull Long unitPrice)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setUnitPrice(unitPrice);
    }
    
    public boolean getUnitPriceHasBeenModified() {
        return _value.getUnitPriceHasBeenModified();
    }
    
    @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();
    }
    
}