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

/**
 * LocationCapacity.java
 */

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

import com.echothree.model.data.warehouse.common.pk.LocationCapacityPK;

import com.echothree.model.data.warehouse.common.pk.LocationPK;
import com.echothree.model.data.uom.common.pk.UnitOfMeasureTypePK;

import com.echothree.model.data.warehouse.server.entity.Location;
import com.echothree.model.data.uom.server.entity.UnitOfMeasureType;

import com.echothree.model.data.warehouse.server.factory.LocationFactory;
import com.echothree.model.data.uom.server.factory.UnitOfMeasureTypeFactory;

import com.echothree.model.data.warehouse.common.pk.LocationCapacityPK;

import com.echothree.model.data.warehouse.server.value.LocationCapacityValue;

import com.echothree.model.data.warehouse.server.factory.LocationCapacityFactory;

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 LocationCapacity
        extends BaseEntity
        implements Serializable {
    
    private LocationCapacityPK _pk;
    private LocationCapacityValue _value;
    
    /** Creates a new instance of LocationCapacity */
    public LocationCapacity()
            throws PersistenceException {
        super();
    }
    
    /** Creates a new instance of LocationCapacity */
    public LocationCapacity(LocationCapacityValue value, EntityPermission entityPermission) {
        super(entityPermission);
        
        _value = value;
        _pk = value.getPrimaryKey();
    }
    
    @Override
    @Nonnull
    public LocationCapacityFactory getBaseFactoryInstance() {
        return LocationCapacityFactory.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 LocationCapacity that) {
            LocationCapacityValue thatValue = that.getLocationCapacityValue();
            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 LocationCapacityValue getLocationCapacityValue() {
        return _value;
    }
    
    public void setLocationCapacityValue(@Nonnull LocationCapacityValue value)
            throws PersistenceReadOnlyException {
        checkReadWrite();
        _value = value;
    }
    
    @Override
    @Nonnull
    public LocationCapacityPK getPrimaryKey() {
        return _pk;
    }
    
    @Nonnull
    public LocationPK getLocationPK() {
        return _value.getLocationPK();
    }
    
    @Nonnull
    public Location getLocation(EntityPermission entityPermission) {
        return LocationFactory.getInstance().getEntityFromPK(entityPermission, getLocationPK());
    }
    
    @Nonnull
    public Location getLocation() {
        return getLocation(EntityPermission.READ_ONLY);
    }
    
    @Nonnull
    public Location getLocationForUpdate() {
        return getLocation(EntityPermission.READ_WRITE);
    }
    
    public void setLocationPK(@Nonnull LocationPK locationPK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setLocationPK(locationPK);
    }
    
    public void setLocation(@Nonnull Location entity) {
        setLocationPK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getLocationPKHasBeenModified() {
        return _value.getLocationPKHasBeenModified();
    }
    
    @Nonnull
    public UnitOfMeasureTypePK getUnitOfMeasureTypePK() {
        return _value.getUnitOfMeasureTypePK();
    }
    
    @Nonnull
    public UnitOfMeasureType getUnitOfMeasureType(EntityPermission entityPermission) {
        return UnitOfMeasureTypeFactory.getInstance().getEntityFromPK(entityPermission, getUnitOfMeasureTypePK());
    }
    
    @Nonnull
    public UnitOfMeasureType getUnitOfMeasureType() {
        return getUnitOfMeasureType(EntityPermission.READ_ONLY);
    }
    
    @Nonnull
    public UnitOfMeasureType getUnitOfMeasureTypeForUpdate() {
        return getUnitOfMeasureType(EntityPermission.READ_WRITE);
    }
    
    public void setUnitOfMeasureTypePK(@Nonnull UnitOfMeasureTypePK unitOfMeasureTypePK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setUnitOfMeasureTypePK(unitOfMeasureTypePK);
    }
    
    public void setUnitOfMeasureType(@Nonnull UnitOfMeasureType entity) {
        setUnitOfMeasureTypePK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getUnitOfMeasureTypePKHasBeenModified() {
        return _value.getUnitOfMeasureTypePKHasBeenModified();
    }
    
    @Nonnull
    public Long getCapacity() {
        return _value.getCapacity();
    }
    
    public void setCapacity(@Nonnull Long capacity)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setCapacity(capacity);
    }
    
    public boolean getCapacityHasBeenModified() {
        return _value.getCapacityHasBeenModified();
    }
    
    @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();
    }
    
}