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

/**
 * LocationNameElementDetail.java
 */

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

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

import com.echothree.model.data.warehouse.common.pk.LocationNameElementPK;
import com.echothree.model.data.warehouse.common.pk.LocationTypePK;

import com.echothree.model.data.warehouse.server.entity.LocationNameElement;
import com.echothree.model.data.warehouse.server.entity.LocationType;

import com.echothree.model.data.warehouse.server.factory.LocationNameElementFactory;
import com.echothree.model.data.warehouse.server.factory.LocationTypeFactory;

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

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

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

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 LocationNameElementDetail
        extends BaseEntity
        implements Serializable {
    
    private LocationNameElementDetailPK _pk;
    private LocationNameElementDetailValue _value;
    
    /** Creates a new instance of LocationNameElementDetail */
    public LocationNameElementDetail()
            throws PersistenceException {
        super();
    }
    
    /** Creates a new instance of LocationNameElementDetail */
    public LocationNameElementDetail(LocationNameElementDetailValue value, EntityPermission entityPermission) {
        super(entityPermission);
        
        _value = value;
        _pk = value.getPrimaryKey();
    }
    
    @Override
    @Nonnull
    public LocationNameElementDetailFactory getBaseFactoryInstance() {
        return LocationNameElementDetailFactory.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 LocationNameElementDetail that) {
            LocationNameElementDetailValue thatValue = that.getLocationNameElementDetailValue();
            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 LocationNameElementDetailValue getLocationNameElementDetailValue() {
        return _value;
    }
    
    public void setLocationNameElementDetailValue(@Nonnull LocationNameElementDetailValue value)
            throws PersistenceReadOnlyException {
        checkReadWrite();
        _value = value;
    }
    
    @Override
    @Nonnull
    public LocationNameElementDetailPK getPrimaryKey() {
        return _pk;
    }
    
    @Nonnull
    public LocationNameElementPK getLocationNameElementPK() {
        return _value.getLocationNameElementPK();
    }
    
    @Nonnull
    public LocationNameElement getLocationNameElement(EntityPermission entityPermission) {
        return LocationNameElementFactory.getInstance().getEntityFromPK(entityPermission, getLocationNameElementPK());
    }
    
    @Nonnull
    public LocationNameElement getLocationNameElement() {
        return getLocationNameElement(EntityPermission.READ_ONLY);
    }
    
    @Nonnull
    public LocationNameElement getLocationNameElementForUpdate() {
        return getLocationNameElement(EntityPermission.READ_WRITE);
    }
    
    public void setLocationNameElementPK(@Nonnull LocationNameElementPK locationNameElementPK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setLocationNameElementPK(locationNameElementPK);
    }
    
    public void setLocationNameElement(@Nonnull LocationNameElement entity) {
        setLocationNameElementPK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getLocationNameElementPKHasBeenModified() {
        return _value.getLocationNameElementPKHasBeenModified();
    }
    
    @Nonnull
    public LocationTypePK getLocationTypePK() {
        return _value.getLocationTypePK();
    }
    
    @Nonnull
    public LocationType getLocationType(EntityPermission entityPermission) {
        return LocationTypeFactory.getInstance().getEntityFromPK(entityPermission, getLocationTypePK());
    }
    
    @Nonnull
    public LocationType getLocationType() {
        return getLocationType(EntityPermission.READ_ONLY);
    }
    
    @Nonnull
    public LocationType getLocationTypeForUpdate() {
        return getLocationType(EntityPermission.READ_WRITE);
    }
    
    public void setLocationTypePK(@Nonnull LocationTypePK locationTypePK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setLocationTypePK(locationTypePK);
    }
    
    public void setLocationType(@Nonnull LocationType entity) {
        setLocationTypePK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getLocationTypePKHasBeenModified() {
        return _value.getLocationTypePKHasBeenModified();
    }
    
    @Nonnull
    public String getLocationNameElementName() {
        return _value.getLocationNameElementName();
    }
    
    public void setLocationNameElementName(@Nonnull String locationNameElementName)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setLocationNameElementName(locationNameElementName);
    }
    
    public boolean getLocationNameElementNameHasBeenModified() {
        return _value.getLocationNameElementNameHasBeenModified();
    }
    
    @Nonnull
    public Integer getOffset() {
        return _value.getOffset();
    }
    
    public void setOffset(@Nonnull Integer offset)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setOffset(offset);
    }
    
    public boolean getOffsetHasBeenModified() {
        return _value.getOffsetHasBeenModified();
    }
    
    @Nonnull
    public Integer getLength() {
        return _value.getLength();
    }
    
    public void setLength(@Nonnull Integer length)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setLength(length);
    }
    
    public boolean getLengthHasBeenModified() {
        return _value.getLengthHasBeenModified();
    }
    
    @Nullable
    public String getValidationPattern() {
        return _value.getValidationPattern();
    }
    
    public void setValidationPattern(@Nullable String validationPattern)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setValidationPattern(validationPattern);
    }
    
    public boolean getValidationPatternHasBeenModified() {
        return _value.getValidationPatternHasBeenModified();
    }
    
    @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();
    }
    
}