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

/**
 * InventoryLocationGroupVolume.java
 */

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

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

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

import com.echothree.model.data.inventory.server.entity.InventoryLocationGroup;

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

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

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

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

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 InventoryLocationGroupVolume
        extends BaseEntity
        implements Serializable {
    
    private InventoryLocationGroupVolumePK _pk;
    private InventoryLocationGroupVolumeValue _value;
    
    /** Creates a new instance of InventoryLocationGroupVolume */
    public InventoryLocationGroupVolume()
            throws PersistenceException {
        super();
    }
    
    /** Creates a new instance of InventoryLocationGroupVolume */
    public InventoryLocationGroupVolume(InventoryLocationGroupVolumeValue value, EntityPermission entityPermission) {
        super(entityPermission);
        
        _value = value;
        _pk = value.getPrimaryKey();
    }
    
    @Override
    @Nonnull
    public InventoryLocationGroupVolumeFactory getBaseFactoryInstance() {
        return InventoryLocationGroupVolumeFactory.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 InventoryLocationGroupVolume that) {
            InventoryLocationGroupVolumeValue thatValue = that.getInventoryLocationGroupVolumeValue();
            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 InventoryLocationGroupVolumeValue getInventoryLocationGroupVolumeValue() {
        return _value;
    }
    
    public void setInventoryLocationGroupVolumeValue(@Nonnull InventoryLocationGroupVolumeValue value)
            throws PersistenceReadOnlyException {
        checkReadWrite();
        _value = value;
    }
    
    @Override
    @Nonnull
    public InventoryLocationGroupVolumePK getPrimaryKey() {
        return _pk;
    }
    
    @Nonnull
    public InventoryLocationGroupPK getInventoryLocationGroupPK() {
        return _value.getInventoryLocationGroupPK();
    }
    
    @Nonnull
    public InventoryLocationGroup getInventoryLocationGroup(EntityPermission entityPermission) {
        return InventoryLocationGroupFactory.getInstance().getEntityFromPK(entityPermission, getInventoryLocationGroupPK());
    }
    
    @Nonnull
    public InventoryLocationGroup getInventoryLocationGroup() {
        return getInventoryLocationGroup(EntityPermission.READ_ONLY);
    }
    
    @Nonnull
    public InventoryLocationGroup getInventoryLocationGroupForUpdate() {
        return getInventoryLocationGroup(EntityPermission.READ_WRITE);
    }
    
    public void setInventoryLocationGroupPK(@Nonnull InventoryLocationGroupPK inventoryLocationGroupPK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setInventoryLocationGroupPK(inventoryLocationGroupPK);
    }
    
    public void setInventoryLocationGroup(@Nonnull InventoryLocationGroup entity) {
        setInventoryLocationGroupPK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getInventoryLocationGroupPKHasBeenModified() {
        return _value.getInventoryLocationGroupPKHasBeenModified();
    }
    
    @Nonnull
    public Long getHeight() {
        return _value.getHeight();
    }
    
    public void setHeight(@Nonnull Long height)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setHeight(height);
    }
    
    public boolean getHeightHasBeenModified() {
        return _value.getHeightHasBeenModified();
    }
    
    @Nonnull
    public Long getWidth() {
        return _value.getWidth();
    }
    
    public void setWidth(@Nonnull Long width)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setWidth(width);
    }
    
    public boolean getWidthHasBeenModified() {
        return _value.getWidthHasBeenModified();
    }
    
    @Nonnull
    public Long getDepth() {
        return _value.getDepth();
    }
    
    public void setDepth(@Nonnull Long depth)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setDepth(depth);
    }
    
    public boolean getDepthHasBeenModified() {
        return _value.getDepthHasBeenModified();
    }
    
    @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();
    }
    
}