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

/**
 * HarmonizedTariffScheduleCodeDetail.java
 */

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

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

import com.echothree.model.data.item.common.pk.HarmonizedTariffScheduleCodePK;
import com.echothree.model.data.geo.common.pk.GeoCodePK;
import com.echothree.model.data.item.common.pk.HarmonizedTariffScheduleCodeUnitPK;

import com.echothree.model.data.item.server.entity.HarmonizedTariffScheduleCode;
import com.echothree.model.data.geo.server.entity.GeoCode;
import com.echothree.model.data.item.server.entity.HarmonizedTariffScheduleCodeUnit;

import com.echothree.model.data.item.server.factory.HarmonizedTariffScheduleCodeFactory;
import com.echothree.model.data.geo.server.factory.GeoCodeFactory;
import com.echothree.model.data.item.server.factory.HarmonizedTariffScheduleCodeUnitFactory;

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

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

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

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 HarmonizedTariffScheduleCodeDetail
        extends BaseEntity
        implements Serializable {
    
    private HarmonizedTariffScheduleCodeDetailPK _pk;
    private HarmonizedTariffScheduleCodeDetailValue _value;
    
    /** Creates a new instance of HarmonizedTariffScheduleCodeDetail */
    public HarmonizedTariffScheduleCodeDetail()
            throws PersistenceException {
        super();
    }
    
    /** Creates a new instance of HarmonizedTariffScheduleCodeDetail */
    public HarmonizedTariffScheduleCodeDetail(HarmonizedTariffScheduleCodeDetailValue value, EntityPermission entityPermission) {
        super(entityPermission);
        
        _value = value;
        _pk = value.getPrimaryKey();
    }
    
    @Override
    @Nonnull
    public HarmonizedTariffScheduleCodeDetailFactory getBaseFactoryInstance() {
        return HarmonizedTariffScheduleCodeDetailFactory.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 HarmonizedTariffScheduleCodeDetail that) {
            HarmonizedTariffScheduleCodeDetailValue thatValue = that.getHarmonizedTariffScheduleCodeDetailValue();
            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 HarmonizedTariffScheduleCodeDetailValue getHarmonizedTariffScheduleCodeDetailValue() {
        return _value;
    }
    
    public void setHarmonizedTariffScheduleCodeDetailValue(@Nonnull HarmonizedTariffScheduleCodeDetailValue value)
            throws PersistenceReadOnlyException {
        checkReadWrite();
        _value = value;
    }
    
    @Override
    @Nonnull
    public HarmonizedTariffScheduleCodeDetailPK getPrimaryKey() {
        return _pk;
    }
    
    @Nonnull
    public HarmonizedTariffScheduleCodePK getHarmonizedTariffScheduleCodePK() {
        return _value.getHarmonizedTariffScheduleCodePK();
    }
    
    @Nonnull
    public HarmonizedTariffScheduleCode getHarmonizedTariffScheduleCode(EntityPermission entityPermission) {
        return HarmonizedTariffScheduleCodeFactory.getInstance().getEntityFromPK(entityPermission, getHarmonizedTariffScheduleCodePK());
    }
    
    @Nonnull
    public HarmonizedTariffScheduleCode getHarmonizedTariffScheduleCode() {
        return getHarmonizedTariffScheduleCode(EntityPermission.READ_ONLY);
    }
    
    @Nonnull
    public HarmonizedTariffScheduleCode getHarmonizedTariffScheduleCodeForUpdate() {
        return getHarmonizedTariffScheduleCode(EntityPermission.READ_WRITE);
    }
    
    public void setHarmonizedTariffScheduleCodePK(@Nonnull HarmonizedTariffScheduleCodePK harmonizedTariffScheduleCodePK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setHarmonizedTariffScheduleCodePK(harmonizedTariffScheduleCodePK);
    }
    
    public void setHarmonizedTariffScheduleCode(@Nonnull HarmonizedTariffScheduleCode entity) {
        setHarmonizedTariffScheduleCodePK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getHarmonizedTariffScheduleCodePKHasBeenModified() {
        return _value.getHarmonizedTariffScheduleCodePKHasBeenModified();
    }
    
    @Nonnull
    public GeoCodePK getCountryGeoCodePK() {
        return _value.getCountryGeoCodePK();
    }
    
    @Nonnull
    public GeoCode getCountryGeoCode(EntityPermission entityPermission) {
        return GeoCodeFactory.getInstance().getEntityFromPK(entityPermission, getCountryGeoCodePK());
    }
    
    @Nonnull
    public GeoCode getCountryGeoCode() {
        return getCountryGeoCode(EntityPermission.READ_ONLY);
    }
    
    @Nonnull
    public GeoCode getCountryGeoCodeForUpdate() {
        return getCountryGeoCode(EntityPermission.READ_WRITE);
    }
    
    public void setCountryGeoCodePK(@Nonnull GeoCodePK countryGeoCodePK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setCountryGeoCodePK(countryGeoCodePK);
    }
    
    public void setCountryGeoCode(@Nonnull GeoCode entity) {
        setCountryGeoCodePK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getCountryGeoCodePKHasBeenModified() {
        return _value.getCountryGeoCodePKHasBeenModified();
    }
    
    @Nonnull
    public String getHarmonizedTariffScheduleCodeName() {
        return _value.getHarmonizedTariffScheduleCodeName();
    }
    
    public void setHarmonizedTariffScheduleCodeName(@Nonnull String harmonizedTariffScheduleCodeName)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setHarmonizedTariffScheduleCodeName(harmonizedTariffScheduleCodeName);
    }
    
    public boolean getHarmonizedTariffScheduleCodeNameHasBeenModified() {
        return _value.getHarmonizedTariffScheduleCodeNameHasBeenModified();
    }
    
    @Nullable
    public HarmonizedTariffScheduleCodeUnitPK getFirstHarmonizedTariffScheduleCodeUnitPK() {
        return _value.getFirstHarmonizedTariffScheduleCodeUnitPK();
    }
    
    @Nullable
    public HarmonizedTariffScheduleCodeUnit getFirstHarmonizedTariffScheduleCodeUnit(EntityPermission entityPermission) {
        HarmonizedTariffScheduleCodeUnitPK pk = getFirstHarmonizedTariffScheduleCodeUnitPK();
        HarmonizedTariffScheduleCodeUnit entity = pk == null? null: HarmonizedTariffScheduleCodeUnitFactory.getInstance().getEntityFromPK(entityPermission, pk);
        
        return entity;
    }
    
    @Nullable
    public HarmonizedTariffScheduleCodeUnit getFirstHarmonizedTariffScheduleCodeUnit() {
        return getFirstHarmonizedTariffScheduleCodeUnit(EntityPermission.READ_ONLY);
    }
    
    @Nullable
    public HarmonizedTariffScheduleCodeUnit getFirstHarmonizedTariffScheduleCodeUnitForUpdate() {
        return getFirstHarmonizedTariffScheduleCodeUnit(EntityPermission.READ_WRITE);
    }
    
    public void setFirstHarmonizedTariffScheduleCodeUnitPK(@Nullable HarmonizedTariffScheduleCodeUnitPK firstHarmonizedTariffScheduleCodeUnitPK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setFirstHarmonizedTariffScheduleCodeUnitPK(firstHarmonizedTariffScheduleCodeUnitPK);
    }
    
    public void setFirstHarmonizedTariffScheduleCodeUnit(@Nullable HarmonizedTariffScheduleCodeUnit entity) {
        setFirstHarmonizedTariffScheduleCodeUnitPK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getFirstHarmonizedTariffScheduleCodeUnitPKHasBeenModified() {
        return _value.getFirstHarmonizedTariffScheduleCodeUnitPKHasBeenModified();
    }
    
    @Nullable
    public HarmonizedTariffScheduleCodeUnitPK getSecondHarmonizedTariffScheduleCodeUnitPK() {
        return _value.getSecondHarmonizedTariffScheduleCodeUnitPK();
    }
    
    @Nullable
    public HarmonizedTariffScheduleCodeUnit getSecondHarmonizedTariffScheduleCodeUnit(EntityPermission entityPermission) {
        HarmonizedTariffScheduleCodeUnitPK pk = getSecondHarmonizedTariffScheduleCodeUnitPK();
        HarmonizedTariffScheduleCodeUnit entity = pk == null? null: HarmonizedTariffScheduleCodeUnitFactory.getInstance().getEntityFromPK(entityPermission, pk);
        
        return entity;
    }
    
    @Nullable
    public HarmonizedTariffScheduleCodeUnit getSecondHarmonizedTariffScheduleCodeUnit() {
        return getSecondHarmonizedTariffScheduleCodeUnit(EntityPermission.READ_ONLY);
    }
    
    @Nullable
    public HarmonizedTariffScheduleCodeUnit getSecondHarmonizedTariffScheduleCodeUnitForUpdate() {
        return getSecondHarmonizedTariffScheduleCodeUnit(EntityPermission.READ_WRITE);
    }
    
    public void setSecondHarmonizedTariffScheduleCodeUnitPK(@Nullable HarmonizedTariffScheduleCodeUnitPK secondHarmonizedTariffScheduleCodeUnitPK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setSecondHarmonizedTariffScheduleCodeUnitPK(secondHarmonizedTariffScheduleCodeUnitPK);
    }
    
    public void setSecondHarmonizedTariffScheduleCodeUnit(@Nullable HarmonizedTariffScheduleCodeUnit entity) {
        setSecondHarmonizedTariffScheduleCodeUnitPK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getSecondHarmonizedTariffScheduleCodeUnitPKHasBeenModified() {
        return _value.getSecondHarmonizedTariffScheduleCodeUnitPKHasBeenModified();
    }
    
    @Nonnull
    public Boolean getIsDefault() {
        return _value.getIsDefault();
    }
    
    public void setIsDefault(@Nonnull Boolean isDefault)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setIsDefault(isDefault);
    }
    
    public boolean getIsDefaultHasBeenModified() {
        return _value.getIsDefaultHasBeenModified();
    }
    
    @Nonnull
    public Integer getSortOrder() {
        return _value.getSortOrder();
    }
    
    public void setSortOrder(@Nonnull Integer sortOrder)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setSortOrder(sortOrder);
    }
    
    public boolean getSortOrderHasBeenModified() {
        return _value.getSortOrderHasBeenModified();
    }
    
    @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();
    }
    
}