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

/**
 * ShippingMethodDetail.java
 */

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

import com.echothree.model.data.shipping.common.pk.ShippingMethodDetailPK;

import com.echothree.model.data.shipping.common.pk.ShippingMethodPK;
import com.echothree.model.data.selector.common.pk.SelectorPK;

import com.echothree.model.data.shipping.server.entity.ShippingMethod;
import com.echothree.model.data.selector.server.entity.Selector;

import com.echothree.model.data.shipping.server.factory.ShippingMethodFactory;
import com.echothree.model.data.selector.server.factory.SelectorFactory;

import com.echothree.model.data.shipping.common.pk.ShippingMethodDetailPK;

import com.echothree.model.data.shipping.server.value.ShippingMethodDetailValue;

import com.echothree.model.data.shipping.server.factory.ShippingMethodDetailFactory;

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 ShippingMethodDetail
        extends BaseEntity
        implements Serializable {
    
    private ShippingMethodDetailPK _pk;
    private ShippingMethodDetailValue _value;
    
    /** Creates a new instance of ShippingMethodDetail */
    public ShippingMethodDetail()
            throws PersistenceException {
        super();
    }
    
    /** Creates a new instance of ShippingMethodDetail */
    public ShippingMethodDetail(ShippingMethodDetailValue value, EntityPermission entityPermission) {
        super(entityPermission);
        
        _value = value;
        _pk = value.getPrimaryKey();
    }
    
    @Override
    @Nonnull
    public ShippingMethodDetailFactory getBaseFactoryInstance() {
        return ShippingMethodDetailFactory.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 ShippingMethodDetail that) {
            ShippingMethodDetailValue thatValue = that.getShippingMethodDetailValue();
            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 ShippingMethodDetailValue getShippingMethodDetailValue() {
        return _value;
    }
    
    public void setShippingMethodDetailValue(@Nonnull ShippingMethodDetailValue value)
            throws PersistenceReadOnlyException {
        checkReadWrite();
        _value = value;
    }
    
    @Override
    @Nonnull
    public ShippingMethodDetailPK getPrimaryKey() {
        return _pk;
    }
    
    @Nonnull
    public ShippingMethodPK getShippingMethodPK() {
        return _value.getShippingMethodPK();
    }
    
    @Nonnull
    public ShippingMethod getShippingMethod(EntityPermission entityPermission) {
        return ShippingMethodFactory.getInstance().getEntityFromPK(entityPermission, getShippingMethodPK());
    }
    
    @Nonnull
    public ShippingMethod getShippingMethod() {
        return getShippingMethod(EntityPermission.READ_ONLY);
    }
    
    @Nonnull
    public ShippingMethod getShippingMethodForUpdate() {
        return getShippingMethod(EntityPermission.READ_WRITE);
    }
    
    public void setShippingMethodPK(@Nonnull ShippingMethodPK shippingMethodPK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setShippingMethodPK(shippingMethodPK);
    }
    
    public void setShippingMethod(@Nonnull ShippingMethod entity) {
        setShippingMethodPK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getShippingMethodPKHasBeenModified() {
        return _value.getShippingMethodPKHasBeenModified();
    }
    
    @Nonnull
    public String getShippingMethodName() {
        return _value.getShippingMethodName();
    }
    
    public void setShippingMethodName(@Nonnull String shippingMethodName)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setShippingMethodName(shippingMethodName);
    }
    
    public boolean getShippingMethodNameHasBeenModified() {
        return _value.getShippingMethodNameHasBeenModified();
    }
    
    @Nullable
    public SelectorPK getGeoCodeSelectorPK() {
        return _value.getGeoCodeSelectorPK();
    }
    
    @Nullable
    public Selector getGeoCodeSelector(EntityPermission entityPermission) {
        SelectorPK pk = getGeoCodeSelectorPK();
        Selector entity = pk == null? null: SelectorFactory.getInstance().getEntityFromPK(entityPermission, pk);
        
        return entity;
    }
    
    @Nullable
    public Selector getGeoCodeSelector() {
        return getGeoCodeSelector(EntityPermission.READ_ONLY);
    }
    
    @Nullable
    public Selector getGeoCodeSelectorForUpdate() {
        return getGeoCodeSelector(EntityPermission.READ_WRITE);
    }
    
    public void setGeoCodeSelectorPK(@Nullable SelectorPK geoCodeSelectorPK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setGeoCodeSelectorPK(geoCodeSelectorPK);
    }
    
    public void setGeoCodeSelector(@Nullable Selector entity) {
        setGeoCodeSelectorPK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getGeoCodeSelectorPKHasBeenModified() {
        return _value.getGeoCodeSelectorPKHasBeenModified();
    }
    
    @Nullable
    public SelectorPK getItemSelectorPK() {
        return _value.getItemSelectorPK();
    }
    
    @Nullable
    public Selector getItemSelector(EntityPermission entityPermission) {
        SelectorPK pk = getItemSelectorPK();
        Selector entity = pk == null? null: SelectorFactory.getInstance().getEntityFromPK(entityPermission, pk);
        
        return entity;
    }
    
    @Nullable
    public Selector getItemSelector() {
        return getItemSelector(EntityPermission.READ_ONLY);
    }
    
    @Nullable
    public Selector getItemSelectorForUpdate() {
        return getItemSelector(EntityPermission.READ_WRITE);
    }
    
    public void setItemSelectorPK(@Nullable SelectorPK itemSelectorPK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setItemSelectorPK(itemSelectorPK);
    }
    
    public void setItemSelector(@Nullable Selector entity) {
        setItemSelectorPK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getItemSelectorPKHasBeenModified() {
        return _value.getItemSelectorPKHasBeenModified();
    }
    
    @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();
    }
    
}