// --------------------------------------------------------------------------------
// Copyright 2002-2024 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;

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
    public CarrierFactory getBaseFactoryInstance() {
        return CarrierFactory.getInstance();
    }
    
    @Override
    public boolean hasBeenModified() {
        return _value.hasBeenModified();
    }
    
    @Override
    public int hashCode() {
        return _pk.hashCode();
    }
    
    @Override
    public String toString() {
        return _pk.toString();
    }
    
    @Override
    public boolean equals(Object other) {
        if(this == other)
            return true;
        
        if(other instanceof Carrier) {
            Carrier that = (Carrier)other;
            
            CarrierValue thatValue = that.getCarrierValue();
            return _value.equals(thatValue);
        } else {
            return false;
        }
    }
    
    @Override
    public void store(Session session)
            throws PersistenceDatabaseException {
        getBaseFactoryInstance().store(session, this);
    }
    
    @Override
    public void remove(Session session)
            throws PersistenceDatabaseException {
        getBaseFactoryInstance().remove(session, this);
    }
    
    @Override
    public void remove()
            throws PersistenceDatabaseException {
        getBaseFactoryInstance().remove(ThreadSession.currentSession(), this);
    }
    
    public CarrierValue getCarrierValue() {
        return _value;
    }
    
    public void setCarrierValue(CarrierValue value)
            throws PersistenceReadOnlyException {
        checkReadWrite();
        _value = value;
    }
    
    @Override
    public CarrierPK getPrimaryKey() {
        return _pk;
    }
    
    public PartyPK getPartyPK() {
        return _value.getPartyPK();
    }
    
    public Party getParty(Session session, EntityPermission entityPermission) {
        return PartyFactory.getInstance().getEntityFromPK(session, entityPermission, getPartyPK());
    }
    
    public Party getParty(EntityPermission entityPermission) {
        return getParty(ThreadSession.currentSession(), entityPermission);
    }
    
    public Party getParty(Session session) {
        return getParty(session, EntityPermission.READ_ONLY);
    }
    
    public Party getParty() {
        return getParty(ThreadSession.currentSession(), EntityPermission.READ_ONLY);
    }
    
    public Party getPartyForUpdate(Session session) {
        return getParty(session, EntityPermission.READ_WRITE);
    }
    
    public Party getPartyForUpdate() {
        return getParty(ThreadSession.currentSession(), EntityPermission.READ_WRITE);
    }
    
    public void setPartyPK(PartyPK partyPK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setPartyPK(partyPK);
    }
    
    public void setParty(Party entity) {
        setPartyPK(entity == null? null: entity.getPrimaryKey());
    }
    
    public boolean getPartyPKHasBeenModified() {
        return _value.getPartyPKHasBeenModified();
    }
    
    public String getCarrierName() {
        return _value.getCarrierName();
    }
    
    public void setCarrierName(String carrierName)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setCarrierName(carrierName);
    }
    
    public boolean getCarrierNameHasBeenModified() {
        return _value.getCarrierNameHasBeenModified();
    }
    
    public CarrierTypePK getCarrierTypePK() {
        return _value.getCarrierTypePK();
    }
    
    public CarrierType getCarrierType(Session session, EntityPermission entityPermission) {
        return CarrierTypeFactory.getInstance().getEntityFromPK(session, entityPermission, getCarrierTypePK());
    }
    
    public CarrierType getCarrierType(EntityPermission entityPermission) {
        return getCarrierType(ThreadSession.currentSession(), entityPermission);
    }
    
    public CarrierType getCarrierType(Session session) {
        return getCarrierType(session, EntityPermission.READ_ONLY);
    }
    
    public CarrierType getCarrierType() {
        return getCarrierType(ThreadSession.currentSession(), EntityPermission.READ_ONLY);
    }
    
    public CarrierType getCarrierTypeForUpdate(Session session) {
        return getCarrierType(session, EntityPermission.READ_WRITE);
    }
    
    public CarrierType getCarrierTypeForUpdate() {
        return getCarrierType(ThreadSession.currentSession(), EntityPermission.READ_WRITE);
    }
    
    public void setCarrierTypePK(CarrierTypePK carrierTypePK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setCarrierTypePK(carrierTypePK);
    }
    
    public void setCarrierType(CarrierType entity) {
        setCarrierTypePK(entity == null? null: entity.getPrimaryKey());
    }
    
    public boolean getCarrierTypePKHasBeenModified() {
        return _value.getCarrierTypePKHasBeenModified();
    }
    
    public SelectorPK getGeoCodeSelectorPK() {
        return _value.getGeoCodeSelectorPK();
    }
    
    public Selector getGeoCodeSelector(Session session, EntityPermission entityPermission) {
        SelectorPK pk = getGeoCodeSelectorPK();
        Selector entity = pk == null? null: SelectorFactory.getInstance().getEntityFromPK(session, entityPermission, pk);
        
        return entity;
    }
    
    public Selector getGeoCodeSelector(EntityPermission entityPermission) {
        return getGeoCodeSelector(ThreadSession.currentSession(), entityPermission);
    }
    
    public Selector getGeoCodeSelector(Session session) {
        return getGeoCodeSelector(session, EntityPermission.READ_ONLY);
    }
    
    public Selector getGeoCodeSelector() {
        return getGeoCodeSelector(ThreadSession.currentSession(), EntityPermission.READ_ONLY);
    }
    
    public Selector getGeoCodeSelectorForUpdate(Session session) {
        return getGeoCodeSelector(session, EntityPermission.READ_WRITE);
    }
    
    public Selector getGeoCodeSelectorForUpdate() {
        return getGeoCodeSelector(ThreadSession.currentSession(), EntityPermission.READ_WRITE);
    }
    
    public void setGeoCodeSelectorPK(SelectorPK geoCodeSelectorPK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setGeoCodeSelectorPK(geoCodeSelectorPK);
    }
    
    public void setGeoCodeSelector(Selector entity) {
        setGeoCodeSelectorPK(entity == null? null: entity.getPrimaryKey());
    }
    
    public boolean getGeoCodeSelectorPKHasBeenModified() {
        return _value.getGeoCodeSelectorPKHasBeenModified();
    }
    
    public SelectorPK getItemSelectorPK() {
        return _value.getItemSelectorPK();
    }
    
    public Selector getItemSelector(Session session, EntityPermission entityPermission) {
        SelectorPK pk = getItemSelectorPK();
        Selector entity = pk == null? null: SelectorFactory.getInstance().getEntityFromPK(session, entityPermission, pk);
        
        return entity;
    }
    
    public Selector getItemSelector(EntityPermission entityPermission) {
        return getItemSelector(ThreadSession.currentSession(), entityPermission);
    }
    
    public Selector getItemSelector(Session session) {
        return getItemSelector(session, EntityPermission.READ_ONLY);
    }
    
    public Selector getItemSelector() {
        return getItemSelector(ThreadSession.currentSession(), EntityPermission.READ_ONLY);
    }
    
    public Selector getItemSelectorForUpdate(Session session) {
        return getItemSelector(session, EntityPermission.READ_WRITE);
    }
    
    public Selector getItemSelectorForUpdate() {
        return getItemSelector(ThreadSession.currentSession(), EntityPermission.READ_WRITE);
    }
    
    public void setItemSelectorPK(SelectorPK itemSelectorPK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setItemSelectorPK(itemSelectorPK);
    }
    
    public void setItemSelector(Selector entity) {
        setItemSelectorPK(entity == null? null: entity.getPrimaryKey());
    }
    
    public boolean getItemSelectorPKHasBeenModified() {
        return _value.getItemSelectorPKHasBeenModified();
    }
    
    public String getAccountValidationPattern() {
        return _value.getAccountValidationPattern();
    }
    
    public void setAccountValidationPattern(String accountValidationPattern)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setAccountValidationPattern(accountValidationPattern);
    }
    
    public boolean getAccountValidationPatternHasBeenModified() {
        return _value.getAccountValidationPatternHasBeenModified();
    }
    
    public Boolean getIsDefault() {
        return _value.getIsDefault();
    }
    
    public void setIsDefault(Boolean isDefault)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setIsDefault(isDefault);
    }
    
    public boolean getIsDefaultHasBeenModified() {
        return _value.getIsDefaultHasBeenModified();
    }
    
    public Integer getSortOrder() {
        return _value.getSortOrder();
    }
    
    public void setSortOrder(Integer sortOrder)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setSortOrder(sortOrder);
    }
    
    public boolean getSortOrderHasBeenModified() {
        return _value.getSortOrderHasBeenModified();
    }
    
    public Long getFromTime() {
        return _value.getFromTime();
    }
    
    public void setFromTime(Long fromTime)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setFromTime(fromTime);
    }
    
    public boolean getFromTimeHasBeenModified() {
        return _value.getFromTimeHasBeenModified();
    }
    
    public Long getThruTime() {
        return _value.getThruTime();
    }
    
    public void setThruTime(Long thruTime)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setThruTime(thruTime);
    }
    
    public boolean getThruTimeHasBeenModified() {
        return _value.getThruTimeHasBeenModified();
    }
    
}