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

/**
 * CarrierOptionDetail.java
 */

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

import com.echothree.model.data.carrier.common.pk.CarrierOptionDetailPK;

import com.echothree.model.data.carrier.common.pk.CarrierOptionPK;
import com.echothree.model.data.party.common.pk.PartyPK;
import com.echothree.model.data.selector.common.pk.SelectorPK;

import com.echothree.model.data.carrier.server.entity.CarrierOption;
import com.echothree.model.data.party.server.entity.Party;
import com.echothree.model.data.selector.server.entity.Selector;

import com.echothree.model.data.carrier.server.factory.CarrierOptionFactory;
import com.echothree.model.data.party.server.factory.PartyFactory;
import com.echothree.model.data.selector.server.factory.SelectorFactory;

import com.echothree.model.data.carrier.common.pk.CarrierOptionDetailPK;

import com.echothree.model.data.carrier.server.value.CarrierOptionDetailValue;

import com.echothree.model.data.carrier.server.factory.CarrierOptionDetailFactory;

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 CarrierOptionDetail
        extends BaseEntity
        implements Serializable {
    
    private CarrierOptionDetailPK _pk;
    private CarrierOptionDetailValue _value;
    
    /** Creates a new instance of CarrierOptionDetail */
    public CarrierOptionDetail()
            throws PersistenceException {
        super();
    }
    
    /** Creates a new instance of CarrierOptionDetail */
    public CarrierOptionDetail(CarrierOptionDetailValue value, EntityPermission entityPermission) {
        super(entityPermission);
        
        _value = value;
        _pk = value.getPrimaryKey();
    }
    
    @Override
    @Nonnull
    public CarrierOptionDetailFactory getBaseFactoryInstance() {
        return CarrierOptionDetailFactory.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 CarrierOptionDetail that) {
            CarrierOptionDetailValue thatValue = that.getCarrierOptionDetailValue();
            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 CarrierOptionDetailValue getCarrierOptionDetailValue() {
        return _value;
    }
    
    public void setCarrierOptionDetailValue(@Nonnull CarrierOptionDetailValue value)
            throws PersistenceReadOnlyException {
        checkReadWrite();
        _value = value;
    }
    
    @Override
    @Nonnull
    public CarrierOptionDetailPK getPrimaryKey() {
        return _pk;
    }
    
    @Nonnull
    public CarrierOptionPK getCarrierOptionPK() {
        return _value.getCarrierOptionPK();
    }
    
    @Nonnull
    public CarrierOption getCarrierOption(EntityPermission entityPermission) {
        return CarrierOptionFactory.getInstance().getEntityFromPK(entityPermission, getCarrierOptionPK());
    }
    
    @Nonnull
    public CarrierOption getCarrierOption() {
        return getCarrierOption(EntityPermission.READ_ONLY);
    }
    
    @Nonnull
    public CarrierOption getCarrierOptionForUpdate() {
        return getCarrierOption(EntityPermission.READ_WRITE);
    }
    
    public void setCarrierOptionPK(@Nonnull CarrierOptionPK carrierOptionPK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setCarrierOptionPK(carrierOptionPK);
    }
    
    public void setCarrierOption(@Nonnull CarrierOption entity) {
        setCarrierOptionPK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getCarrierOptionPKHasBeenModified() {
        return _value.getCarrierOptionPKHasBeenModified();
    }
    
    @Nonnull
    public PartyPK getCarrierPartyPK() {
        return _value.getCarrierPartyPK();
    }
    
    @Nonnull
    public Party getCarrierParty(EntityPermission entityPermission) {
        return PartyFactory.getInstance().getEntityFromPK(entityPermission, getCarrierPartyPK());
    }
    
    @Nonnull
    public Party getCarrierParty() {
        return getCarrierParty(EntityPermission.READ_ONLY);
    }
    
    @Nonnull
    public Party getCarrierPartyForUpdate() {
        return getCarrierParty(EntityPermission.READ_WRITE);
    }
    
    public void setCarrierPartyPK(@Nonnull PartyPK carrierPartyPK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setCarrierPartyPK(carrierPartyPK);
    }
    
    public void setCarrierParty(@Nonnull Party entity) {
        setCarrierPartyPK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getCarrierPartyPKHasBeenModified() {
        return _value.getCarrierPartyPKHasBeenModified();
    }
    
    @Nonnull
    public String getCarrierOptionName() {
        return _value.getCarrierOptionName();
    }
    
    public void setCarrierOptionName(@Nonnull String carrierOptionName)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setCarrierOptionName(carrierOptionName);
    }
    
    public boolean getCarrierOptionNameHasBeenModified() {
        return _value.getCarrierOptionNameHasBeenModified();
    }
    
    @Nonnull
    public Boolean getIsRecommended() {
        return _value.getIsRecommended();
    }
    
    public void setIsRecommended(@Nonnull Boolean isRecommended)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setIsRecommended(isRecommended);
    }
    
    public boolean getIsRecommendedHasBeenModified() {
        return _value.getIsRecommendedHasBeenModified();
    }
    
    @Nonnull
    public Boolean getIsRequired() {
        return _value.getIsRequired();
    }
    
    public void setIsRequired(@Nonnull Boolean isRequired)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setIsRequired(isRequired);
    }
    
    public boolean getIsRequiredHasBeenModified() {
        return _value.getIsRequiredHasBeenModified();
    }
    
    @Nullable
    public SelectorPK getRecommendedGeoCodeSelectorPK() {
        return _value.getRecommendedGeoCodeSelectorPK();
    }
    
    @Nullable
    public Selector getRecommendedGeoCodeSelector(EntityPermission entityPermission) {
        SelectorPK pk = getRecommendedGeoCodeSelectorPK();
        Selector entity = pk == null? null: SelectorFactory.getInstance().getEntityFromPK(entityPermission, pk);
        
        return entity;
    }
    
    @Nullable
    public Selector getRecommendedGeoCodeSelector() {
        return getRecommendedGeoCodeSelector(EntityPermission.READ_ONLY);
    }
    
    @Nullable
    public Selector getRecommendedGeoCodeSelectorForUpdate() {
        return getRecommendedGeoCodeSelector(EntityPermission.READ_WRITE);
    }
    
    public void setRecommendedGeoCodeSelectorPK(@Nullable SelectorPK recommendedGeoCodeSelectorPK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setRecommendedGeoCodeSelectorPK(recommendedGeoCodeSelectorPK);
    }
    
    public void setRecommendedGeoCodeSelector(@Nullable Selector entity) {
        setRecommendedGeoCodeSelectorPK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getRecommendedGeoCodeSelectorPKHasBeenModified() {
        return _value.getRecommendedGeoCodeSelectorPKHasBeenModified();
    }
    
    @Nullable
    public SelectorPK getRequiredGeoCodeSelectorPK() {
        return _value.getRequiredGeoCodeSelectorPK();
    }
    
    @Nullable
    public Selector getRequiredGeoCodeSelector(EntityPermission entityPermission) {
        SelectorPK pk = getRequiredGeoCodeSelectorPK();
        Selector entity = pk == null? null: SelectorFactory.getInstance().getEntityFromPK(entityPermission, pk);
        
        return entity;
    }
    
    @Nullable
    public Selector getRequiredGeoCodeSelector() {
        return getRequiredGeoCodeSelector(EntityPermission.READ_ONLY);
    }
    
    @Nullable
    public Selector getRequiredGeoCodeSelectorForUpdate() {
        return getRequiredGeoCodeSelector(EntityPermission.READ_WRITE);
    }
    
    public void setRequiredGeoCodeSelectorPK(@Nullable SelectorPK requiredGeoCodeSelectorPK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setRequiredGeoCodeSelectorPK(requiredGeoCodeSelectorPK);
    }
    
    public void setRequiredGeoCodeSelector(@Nullable Selector entity) {
        setRequiredGeoCodeSelectorPK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getRequiredGeoCodeSelectorPKHasBeenModified() {
        return _value.getRequiredGeoCodeSelectorPKHasBeenModified();
    }
    
    @Nullable
    public SelectorPK getRecommendedItemSelectorPK() {
        return _value.getRecommendedItemSelectorPK();
    }
    
    @Nullable
    public Selector getRecommendedItemSelector(EntityPermission entityPermission) {
        SelectorPK pk = getRecommendedItemSelectorPK();
        Selector entity = pk == null? null: SelectorFactory.getInstance().getEntityFromPK(entityPermission, pk);
        
        return entity;
    }
    
    @Nullable
    public Selector getRecommendedItemSelector() {
        return getRecommendedItemSelector(EntityPermission.READ_ONLY);
    }
    
    @Nullable
    public Selector getRecommendedItemSelectorForUpdate() {
        return getRecommendedItemSelector(EntityPermission.READ_WRITE);
    }
    
    public void setRecommendedItemSelectorPK(@Nullable SelectorPK recommendedItemSelectorPK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setRecommendedItemSelectorPK(recommendedItemSelectorPK);
    }
    
    public void setRecommendedItemSelector(@Nullable Selector entity) {
        setRecommendedItemSelectorPK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getRecommendedItemSelectorPKHasBeenModified() {
        return _value.getRecommendedItemSelectorPKHasBeenModified();
    }
    
    @Nullable
    public SelectorPK getRequiredItemSelectorPK() {
        return _value.getRequiredItemSelectorPK();
    }
    
    @Nullable
    public Selector getRequiredItemSelector(EntityPermission entityPermission) {
        SelectorPK pk = getRequiredItemSelectorPK();
        Selector entity = pk == null? null: SelectorFactory.getInstance().getEntityFromPK(entityPermission, pk);
        
        return entity;
    }
    
    @Nullable
    public Selector getRequiredItemSelector() {
        return getRequiredItemSelector(EntityPermission.READ_ONLY);
    }
    
    @Nullable
    public Selector getRequiredItemSelectorForUpdate() {
        return getRequiredItemSelector(EntityPermission.READ_WRITE);
    }
    
    public void setRequiredItemSelectorPK(@Nullable SelectorPK requiredItemSelectorPK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setRequiredItemSelectorPK(requiredItemSelectorPK);
    }
    
    public void setRequiredItemSelector(@Nullable Selector entity) {
        setRequiredItemSelectorPK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getRequiredItemSelectorPKHasBeenModified() {
        return _value.getRequiredItemSelectorPKHasBeenModified();
    }
    
    @Nullable
    public SelectorPK getRecommendedOrderSelectorPK() {
        return _value.getRecommendedOrderSelectorPK();
    }
    
    @Nullable
    public Selector getRecommendedOrderSelector(EntityPermission entityPermission) {
        SelectorPK pk = getRecommendedOrderSelectorPK();
        Selector entity = pk == null? null: SelectorFactory.getInstance().getEntityFromPK(entityPermission, pk);
        
        return entity;
    }
    
    @Nullable
    public Selector getRecommendedOrderSelector() {
        return getRecommendedOrderSelector(EntityPermission.READ_ONLY);
    }
    
    @Nullable
    public Selector getRecommendedOrderSelectorForUpdate() {
        return getRecommendedOrderSelector(EntityPermission.READ_WRITE);
    }
    
    public void setRecommendedOrderSelectorPK(@Nullable SelectorPK recommendedOrderSelectorPK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setRecommendedOrderSelectorPK(recommendedOrderSelectorPK);
    }
    
    public void setRecommendedOrderSelector(@Nullable Selector entity) {
        setRecommendedOrderSelectorPK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getRecommendedOrderSelectorPKHasBeenModified() {
        return _value.getRecommendedOrderSelectorPKHasBeenModified();
    }
    
    @Nullable
    public SelectorPK getRequiredOrderSelectorPK() {
        return _value.getRequiredOrderSelectorPK();
    }
    
    @Nullable
    public Selector getRequiredOrderSelector(EntityPermission entityPermission) {
        SelectorPK pk = getRequiredOrderSelectorPK();
        Selector entity = pk == null? null: SelectorFactory.getInstance().getEntityFromPK(entityPermission, pk);
        
        return entity;
    }
    
    @Nullable
    public Selector getRequiredOrderSelector() {
        return getRequiredOrderSelector(EntityPermission.READ_ONLY);
    }
    
    @Nullable
    public Selector getRequiredOrderSelectorForUpdate() {
        return getRequiredOrderSelector(EntityPermission.READ_WRITE);
    }
    
    public void setRequiredOrderSelectorPK(@Nullable SelectorPK requiredOrderSelectorPK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setRequiredOrderSelectorPK(requiredOrderSelectorPK);
    }
    
    public void setRequiredOrderSelector(@Nullable Selector entity) {
        setRequiredOrderSelectorPK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getRequiredOrderSelectorPKHasBeenModified() {
        return _value.getRequiredOrderSelectorPKHasBeenModified();
    }
    
    @Nullable
    public SelectorPK getRecommendedShipmentSelectorPK() {
        return _value.getRecommendedShipmentSelectorPK();
    }
    
    @Nullable
    public Selector getRecommendedShipmentSelector(EntityPermission entityPermission) {
        SelectorPK pk = getRecommendedShipmentSelectorPK();
        Selector entity = pk == null? null: SelectorFactory.getInstance().getEntityFromPK(entityPermission, pk);
        
        return entity;
    }
    
    @Nullable
    public Selector getRecommendedShipmentSelector() {
        return getRecommendedShipmentSelector(EntityPermission.READ_ONLY);
    }
    
    @Nullable
    public Selector getRecommendedShipmentSelectorForUpdate() {
        return getRecommendedShipmentSelector(EntityPermission.READ_WRITE);
    }
    
    public void setRecommendedShipmentSelectorPK(@Nullable SelectorPK recommendedShipmentSelectorPK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setRecommendedShipmentSelectorPK(recommendedShipmentSelectorPK);
    }
    
    public void setRecommendedShipmentSelector(@Nullable Selector entity) {
        setRecommendedShipmentSelectorPK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getRecommendedShipmentSelectorPKHasBeenModified() {
        return _value.getRecommendedShipmentSelectorPKHasBeenModified();
    }
    
    @Nullable
    public SelectorPK getRequiredShipmentSelectorPK() {
        return _value.getRequiredShipmentSelectorPK();
    }
    
    @Nullable
    public Selector getRequiredShipmentSelector(EntityPermission entityPermission) {
        SelectorPK pk = getRequiredShipmentSelectorPK();
        Selector entity = pk == null? null: SelectorFactory.getInstance().getEntityFromPK(entityPermission, pk);
        
        return entity;
    }
    
    @Nullable
    public Selector getRequiredShipmentSelector() {
        return getRequiredShipmentSelector(EntityPermission.READ_ONLY);
    }
    
    @Nullable
    public Selector getRequiredShipmentSelectorForUpdate() {
        return getRequiredShipmentSelector(EntityPermission.READ_WRITE);
    }
    
    public void setRequiredShipmentSelectorPK(@Nullable SelectorPK requiredShipmentSelectorPK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setRequiredShipmentSelectorPK(requiredShipmentSelectorPK);
    }
    
    public void setRequiredShipmentSelector(@Nullable Selector entity) {
        setRequiredShipmentSelectorPK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getRequiredShipmentSelectorPKHasBeenModified() {
        return _value.getRequiredShipmentSelectorPKHasBeenModified();
    }
    
    @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();
    }
    
}