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

/**
 * InventoryLayerDetail.java
 */

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

import com.echothree.model.data.inventory.common.pk.InventoryLayerDetailPK;

import com.echothree.model.data.inventory.common.pk.InventoryLayerPK;
import com.echothree.model.data.inventory.common.pk.InventoryTransactionLinePK;

import com.echothree.model.data.inventory.server.entity.InventoryLayer;
import com.echothree.model.data.inventory.server.entity.InventoryTransactionLine;

import com.echothree.model.data.inventory.server.factory.InventoryLayerFactory;
import com.echothree.model.data.inventory.server.factory.InventoryTransactionLineFactory;

import com.echothree.model.data.inventory.common.pk.InventoryLayerDetailPK;

import com.echothree.model.data.inventory.server.value.InventoryLayerDetailValue;

import com.echothree.model.data.inventory.server.factory.InventoryLayerDetailFactory;

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 InventoryLayerDetail
        extends BaseEntity
        implements Serializable {
    
    private InventoryLayerDetailPK _pk;
    private InventoryLayerDetailValue _value;
    
    /** Creates a new instance of InventoryLayerDetail */
    public InventoryLayerDetail()
            throws PersistenceException {
        super();
    }
    
    /** Creates a new instance of InventoryLayerDetail */
    public InventoryLayerDetail(InventoryLayerDetailValue value, EntityPermission entityPermission) {
        super(entityPermission);
        
        _value = value;
        _pk = value.getPrimaryKey();
    }
    
    @Override
    @Nonnull
    public InventoryLayerDetailFactory getBaseFactoryInstance() {
        return InventoryLayerDetailFactory.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 InventoryLayerDetail that) {
            InventoryLayerDetailValue thatValue = that.getInventoryLayerDetailValue();
            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 InventoryLayerDetailValue getInventoryLayerDetailValue() {
        return _value;
    }
    
    public void setInventoryLayerDetailValue(@Nonnull InventoryLayerDetailValue value)
            throws PersistenceReadOnlyException {
        checkReadWrite();
        _value = value;
    }
    
    @Override
    @Nonnull
    public InventoryLayerDetailPK getPrimaryKey() {
        return _pk;
    }
    
    @Nonnull
    public InventoryLayerPK getInventoryLayerPK() {
        return _value.getInventoryLayerPK();
    }
    
    @Nonnull
    public InventoryLayer getInventoryLayer(EntityPermission entityPermission) {
        return InventoryLayerFactory.getInstance().getEntityFromPK(entityPermission, getInventoryLayerPK());
    }
    
    @Nonnull
    public InventoryLayer getInventoryLayer() {
        return getInventoryLayer(EntityPermission.READ_ONLY);
    }
    
    @Nonnull
    public InventoryLayer getInventoryLayerForUpdate() {
        return getInventoryLayer(EntityPermission.READ_WRITE);
    }
    
    public void setInventoryLayerPK(@Nonnull InventoryLayerPK inventoryLayerPK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setInventoryLayerPK(inventoryLayerPK);
    }
    
    public void setInventoryLayer(@Nonnull InventoryLayer entity) {
        setInventoryLayerPK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getInventoryLayerPKHasBeenModified() {
        return _value.getInventoryLayerPKHasBeenModified();
    }
    
    @Nonnull
    public Integer getInventoryLayerSequence() {
        return _value.getInventoryLayerSequence();
    }
    
    public void setInventoryLayerSequence(@Nonnull Integer inventoryLayerSequence)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setInventoryLayerSequence(inventoryLayerSequence);
    }
    
    public boolean getInventoryLayerSequenceHasBeenModified() {
        return _value.getInventoryLayerSequenceHasBeenModified();
    }
    
    @Nonnull
    public InventoryTransactionLinePK getInventoryTransactionLinePK() {
        return _value.getInventoryTransactionLinePK();
    }
    
    @Nonnull
    public InventoryTransactionLine getInventoryTransactionLine(EntityPermission entityPermission) {
        return InventoryTransactionLineFactory.getInstance().getEntityFromPK(entityPermission, getInventoryTransactionLinePK());
    }
    
    @Nonnull
    public InventoryTransactionLine getInventoryTransactionLine() {
        return getInventoryTransactionLine(EntityPermission.READ_ONLY);
    }
    
    @Nonnull
    public InventoryTransactionLine getInventoryTransactionLineForUpdate() {
        return getInventoryTransactionLine(EntityPermission.READ_WRITE);
    }
    
    public void setInventoryTransactionLinePK(@Nonnull InventoryTransactionLinePK inventoryTransactionLinePK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setInventoryTransactionLinePK(inventoryTransactionLinePK);
    }
    
    public void setInventoryTransactionLine(@Nonnull InventoryTransactionLine entity) {
        setInventoryTransactionLinePK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getInventoryTransactionLinePKHasBeenModified() {
        return _value.getInventoryTransactionLinePKHasBeenModified();
    }
    
    @Nonnull
    public Long getReceiptQuantity() {
        return _value.getReceiptQuantity();
    }
    
    public void setReceiptQuantity(@Nonnull Long receiptQuantity)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setReceiptQuantity(receiptQuantity);
    }
    
    public boolean getReceiptQuantityHasBeenModified() {
        return _value.getReceiptQuantityHasBeenModified();
    }
    
    @Nullable
    public Long getUnitAmount() {
        return _value.getUnitAmount();
    }
    
    public void setUnitAmount(@Nullable Long unitAmount)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setUnitAmount(unitAmount);
    }
    
    public boolean getUnitAmountHasBeenModified() {
        return _value.getUnitAmountHasBeenModified();
    }
    
    @Nullable
    public String getDescription() {
        return _value.getDescription();
    }
    
    public void setDescription(@Nullable String description)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setDescription(description);
    }
    
    public boolean getDescriptionHasBeenModified() {
        return _value.getDescriptionHasBeenModified();
    }
    
    @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();
    }
    
}