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

/**
 * Carrier.java
 */

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

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

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

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

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

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

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

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

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 Carrier
        extends BaseEntity
        implements Serializable {
    
    private CarrierPK _pk;
    private CarrierValue _value;
    
    /** Creates a new instance of Carrier */
    public Carrier()
            throws PersistenceException {
        super();
    }
    
    /** Creates a new instance of Carrier */
    public Carrier(CarrierValue value, EntityPermission entityPermission) {
        super(entityPermission);
        
        _value = value;
        _pk = value.getPrimaryKey();
    }
    
    @Override
    @Nonnull
    public CarrierFactory getBaseFactoryInstance() {
        return CarrierFactory.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 Carrier that) {
            CarrierValue thatValue = that.getCarrierValue();
            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 CarrierValue getCarrierValue() {
        return _value;
    }
    
    public void setCarrierValue(@Nonnull CarrierValue value)
            throws PersistenceReadOnlyException {
        checkReadWrite();
        _value = value;
    }
    
    @Override
    @Nonnull
    public CarrierPK getPrimaryKey() {
        return _pk;
    }
    
    @Nonnull
    public PartyPK getPartyPK() {
        return _value.getPartyPK();
    }
    
    @Nonnull
    public Party getParty(EntityPermission entityPermission) {
        return PartyFactory.getInstance().getEntityFromPK(entityPermission, getPartyPK());
    }
    
    @Nonnull
    public Party getParty() {
        return getParty(EntityPermission.READ_ONLY);
    }
    
    @Nonnull
    public Party getPartyForUpdate() {
        return getParty(EntityPermission.READ_WRITE);
    }
    
    public void setPartyPK(@Nonnull PartyPK partyPK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setPartyPK(partyPK);
    }
    
    public void setParty(@Nonnull Party entity) {
        setPartyPK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getPartyPKHasBeenModified() {
        return _value.getPartyPKHasBeenModified();
    }
    
    @Nonnull
    public String getCarrierName() {
        return _value.getCarrierName();
    }
    
    public void setCarrierName(@Nonnull String carrierName)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setCarrierName(carrierName);
    }
    
    public boolean getCarrierNameHasBeenModified() {
        return _value.getCarrierNameHasBeenModified();
    }
    
    @Nonnull
    public CarrierTypePK getCarrierTypePK() {
        return _value.getCarrierTypePK();
    }
    
    @Nonnull
    public CarrierType getCarrierType(EntityPermission entityPermission) {
        return CarrierTypeFactory.getInstance().getEntityFromPK(entityPermission, getCarrierTypePK());
    }
    
    @Nonnull
    public CarrierType getCarrierType() {
        return getCarrierType(EntityPermission.READ_ONLY);
    }
    
    @Nonnull
    public CarrierType getCarrierTypeForUpdate() {
        return getCarrierType(EntityPermission.READ_WRITE);
    }
    
    public void setCarrierTypePK(@Nonnull CarrierTypePK carrierTypePK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setCarrierTypePK(carrierTypePK);
    }
    
    public void setCarrierType(@Nonnull CarrierType entity) {
        setCarrierTypePK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getCarrierTypePKHasBeenModified() {
        return _value.getCarrierTypePKHasBeenModified();
    }
    
    @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();
    }
    
    @Nullable
    public String getAccountValidationPattern() {
        return _value.getAccountValidationPattern();
    }
    
    public void setAccountValidationPattern(@Nullable String accountValidationPattern)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setAccountValidationPattern(accountValidationPattern);
    }
    
    public boolean getAccountValidationPatternHasBeenModified() {
        return _value.getAccountValidationPatternHasBeenModified();
    }
    
    @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();
    }
    
}