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

/**
 * ShipmentDetail.java
 */

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

import com.echothree.model.data.shipment.common.pk.ShipmentDetailPK;

import com.echothree.model.data.shipment.common.pk.ShipmentPK;
import com.echothree.model.data.shipment.common.pk.ShipmentTypePK;
import com.echothree.model.data.party.common.pk.PartyPK;
import com.echothree.model.data.contact.common.pk.PartyContactMechanismPK;
import com.echothree.model.data.shipping.common.pk.ShippingMethodPK;

import com.echothree.model.data.shipment.server.entity.Shipment;
import com.echothree.model.data.shipment.server.entity.ShipmentType;
import com.echothree.model.data.party.server.entity.Party;
import com.echothree.model.data.contact.server.entity.PartyContactMechanism;
import com.echothree.model.data.shipping.server.entity.ShippingMethod;

import com.echothree.model.data.shipment.server.factory.ShipmentFactory;
import com.echothree.model.data.shipment.server.factory.ShipmentTypeFactory;
import com.echothree.model.data.party.server.factory.PartyFactory;
import com.echothree.model.data.contact.server.factory.PartyContactMechanismFactory;
import com.echothree.model.data.shipping.server.factory.ShippingMethodFactory;

import com.echothree.model.data.shipment.common.pk.ShipmentDetailPK;

import com.echothree.model.data.shipment.server.value.ShipmentDetailValue;

import com.echothree.model.data.shipment.server.factory.ShipmentDetailFactory;

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 ShipmentDetail
        extends BaseEntity
        implements Serializable {
    
    private ShipmentDetailPK _pk;
    private ShipmentDetailValue _value;
    
    /** Creates a new instance of ShipmentDetail */
    public ShipmentDetail()
            throws PersistenceException {
        super();
    }
    
    /** Creates a new instance of ShipmentDetail */
    public ShipmentDetail(ShipmentDetailValue value, EntityPermission entityPermission) {
        super(entityPermission);
        
        _value = value;
        _pk = value.getPrimaryKey();
    }
    
    @Override
    @Nonnull
    public ShipmentDetailFactory getBaseFactoryInstance() {
        return ShipmentDetailFactory.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 ShipmentDetail that) {
            ShipmentDetailValue thatValue = that.getShipmentDetailValue();
            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 ShipmentDetailValue getShipmentDetailValue() {
        return _value;
    }
    
    public void setShipmentDetailValue(@Nonnull ShipmentDetailValue value)
            throws PersistenceReadOnlyException {
        checkReadWrite();
        _value = value;
    }
    
    @Override
    @Nonnull
    public ShipmentDetailPK getPrimaryKey() {
        return _pk;
    }
    
    @Nonnull
    public ShipmentPK getShipmentPK() {
        return _value.getShipmentPK();
    }
    
    @Nonnull
    public Shipment getShipment(EntityPermission entityPermission) {
        return ShipmentFactory.getInstance().getEntityFromPK(entityPermission, getShipmentPK());
    }
    
    @Nonnull
    public Shipment getShipment() {
        return getShipment(EntityPermission.READ_ONLY);
    }
    
    @Nonnull
    public Shipment getShipmentForUpdate() {
        return getShipment(EntityPermission.READ_WRITE);
    }
    
    public void setShipmentPK(@Nonnull ShipmentPK shipmentPK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setShipmentPK(shipmentPK);
    }
    
    public void setShipment(@Nonnull Shipment entity) {
        setShipmentPK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getShipmentPKHasBeenModified() {
        return _value.getShipmentPKHasBeenModified();
    }
    
    @Nonnull
    public ShipmentTypePK getShipmentTypePK() {
        return _value.getShipmentTypePK();
    }
    
    @Nonnull
    public ShipmentType getShipmentType(EntityPermission entityPermission) {
        return ShipmentTypeFactory.getInstance().getEntityFromPK(entityPermission, getShipmentTypePK());
    }
    
    @Nonnull
    public ShipmentType getShipmentType() {
        return getShipmentType(EntityPermission.READ_ONLY);
    }
    
    @Nonnull
    public ShipmentType getShipmentTypeForUpdate() {
        return getShipmentType(EntityPermission.READ_WRITE);
    }
    
    public void setShipmentTypePK(@Nonnull ShipmentTypePK shipmentTypePK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setShipmentTypePK(shipmentTypePK);
    }
    
    public void setShipmentType(@Nonnull ShipmentType entity) {
        setShipmentTypePK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getShipmentTypePKHasBeenModified() {
        return _value.getShipmentTypePKHasBeenModified();
    }
    
    @Nonnull
    public String getShipmentName() {
        return _value.getShipmentName();
    }
    
    public void setShipmentName(@Nonnull String shipmentName)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setShipmentName(shipmentName);
    }
    
    public boolean getShipmentNameHasBeenModified() {
        return _value.getShipmentNameHasBeenModified();
    }
    
    @Nonnull
    public PartyPK getOriginPartyPK() {
        return _value.getOriginPartyPK();
    }
    
    @Nonnull
    public Party getOriginParty(EntityPermission entityPermission) {
        return PartyFactory.getInstance().getEntityFromPK(entityPermission, getOriginPartyPK());
    }
    
    @Nonnull
    public Party getOriginParty() {
        return getOriginParty(EntityPermission.READ_ONLY);
    }
    
    @Nonnull
    public Party getOriginPartyForUpdate() {
        return getOriginParty(EntityPermission.READ_WRITE);
    }
    
    public void setOriginPartyPK(@Nonnull PartyPK originPartyPK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setOriginPartyPK(originPartyPK);
    }
    
    public void setOriginParty(@Nonnull Party entity) {
        setOriginPartyPK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getOriginPartyPKHasBeenModified() {
        return _value.getOriginPartyPKHasBeenModified();
    }
    
    @Nullable
    public PartyPK getOriginWarehousePartyPK() {
        return _value.getOriginWarehousePartyPK();
    }
    
    @Nullable
    public Party getOriginWarehouseParty(EntityPermission entityPermission) {
        PartyPK pk = getOriginWarehousePartyPK();
        Party entity = pk == null? null: PartyFactory.getInstance().getEntityFromPK(entityPermission, pk);
        
        return entity;
    }
    
    @Nullable
    public Party getOriginWarehouseParty() {
        return getOriginWarehouseParty(EntityPermission.READ_ONLY);
    }
    
    @Nullable
    public Party getOriginWarehousePartyForUpdate() {
        return getOriginWarehouseParty(EntityPermission.READ_WRITE);
    }
    
    public void setOriginWarehousePartyPK(@Nullable PartyPK originWarehousePartyPK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setOriginWarehousePartyPK(originWarehousePartyPK);
    }
    
    public void setOriginWarehouseParty(@Nullable Party entity) {
        setOriginWarehousePartyPK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getOriginWarehousePartyPKHasBeenModified() {
        return _value.getOriginWarehousePartyPKHasBeenModified();
    }
    
    @Nullable
    public PartyContactMechanismPK getOriginPartyContactMechanismPK() {
        return _value.getOriginPartyContactMechanismPK();
    }
    
    @Nullable
    public PartyContactMechanism getOriginPartyContactMechanism(EntityPermission entityPermission) {
        PartyContactMechanismPK pk = getOriginPartyContactMechanismPK();
        PartyContactMechanism entity = pk == null? null: PartyContactMechanismFactory.getInstance().getEntityFromPK(entityPermission, pk);
        
        return entity;
    }
    
    @Nullable
    public PartyContactMechanism getOriginPartyContactMechanism() {
        return getOriginPartyContactMechanism(EntityPermission.READ_ONLY);
    }
    
    @Nullable
    public PartyContactMechanism getOriginPartyContactMechanismForUpdate() {
        return getOriginPartyContactMechanism(EntityPermission.READ_WRITE);
    }
    
    public void setOriginPartyContactMechanismPK(@Nullable PartyContactMechanismPK originPartyContactMechanismPK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setOriginPartyContactMechanismPK(originPartyContactMechanismPK);
    }
    
    public void setOriginPartyContactMechanism(@Nullable PartyContactMechanism entity) {
        setOriginPartyContactMechanismPK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getOriginPartyContactMechanismPKHasBeenModified() {
        return _value.getOriginPartyContactMechanismPKHasBeenModified();
    }
    
    @Nonnull
    public PartyPK getDestinationPartyPK() {
        return _value.getDestinationPartyPK();
    }
    
    @Nonnull
    public Party getDestinationParty(EntityPermission entityPermission) {
        return PartyFactory.getInstance().getEntityFromPK(entityPermission, getDestinationPartyPK());
    }
    
    @Nonnull
    public Party getDestinationParty() {
        return getDestinationParty(EntityPermission.READ_ONLY);
    }
    
    @Nonnull
    public Party getDestinationPartyForUpdate() {
        return getDestinationParty(EntityPermission.READ_WRITE);
    }
    
    public void setDestinationPartyPK(@Nonnull PartyPK destinationPartyPK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setDestinationPartyPK(destinationPartyPK);
    }
    
    public void setDestinationParty(@Nonnull Party entity) {
        setDestinationPartyPK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getDestinationPartyPKHasBeenModified() {
        return _value.getDestinationPartyPKHasBeenModified();
    }
    
    @Nullable
    public PartyPK getDestinationWarehousePartyPK() {
        return _value.getDestinationWarehousePartyPK();
    }
    
    @Nullable
    public Party getDestinationWarehouseParty(EntityPermission entityPermission) {
        PartyPK pk = getDestinationWarehousePartyPK();
        Party entity = pk == null? null: PartyFactory.getInstance().getEntityFromPK(entityPermission, pk);
        
        return entity;
    }
    
    @Nullable
    public Party getDestinationWarehouseParty() {
        return getDestinationWarehouseParty(EntityPermission.READ_ONLY);
    }
    
    @Nullable
    public Party getDestinationWarehousePartyForUpdate() {
        return getDestinationWarehouseParty(EntityPermission.READ_WRITE);
    }
    
    public void setDestinationWarehousePartyPK(@Nullable PartyPK destinationWarehousePartyPK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setDestinationWarehousePartyPK(destinationWarehousePartyPK);
    }
    
    public void setDestinationWarehouseParty(@Nullable Party entity) {
        setDestinationWarehousePartyPK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getDestinationWarehousePartyPKHasBeenModified() {
        return _value.getDestinationWarehousePartyPKHasBeenModified();
    }
    
    @Nullable
    public PartyContactMechanismPK getDestinationPartyContactMechanismPK() {
        return _value.getDestinationPartyContactMechanismPK();
    }
    
    @Nullable
    public PartyContactMechanism getDestinationPartyContactMechanism(EntityPermission entityPermission) {
        PartyContactMechanismPK pk = getDestinationPartyContactMechanismPK();
        PartyContactMechanism entity = pk == null? null: PartyContactMechanismFactory.getInstance().getEntityFromPK(entityPermission, pk);
        
        return entity;
    }
    
    @Nullable
    public PartyContactMechanism getDestinationPartyContactMechanism() {
        return getDestinationPartyContactMechanism(EntityPermission.READ_ONLY);
    }
    
    @Nullable
    public PartyContactMechanism getDestinationPartyContactMechanismForUpdate() {
        return getDestinationPartyContactMechanism(EntityPermission.READ_WRITE);
    }
    
    public void setDestinationPartyContactMechanismPK(@Nullable PartyContactMechanismPK destinationPartyContactMechanismPK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setDestinationPartyContactMechanismPK(destinationPartyContactMechanismPK);
    }
    
    public void setDestinationPartyContactMechanism(@Nullable PartyContactMechanism entity) {
        setDestinationPartyContactMechanismPK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getDestinationPartyContactMechanismPKHasBeenModified() {
        return _value.getDestinationPartyContactMechanismPKHasBeenModified();
    }
    
    @Nullable
    public ShippingMethodPK getShippingMethodPK() {
        return _value.getShippingMethodPK();
    }
    
    @Nullable
    public ShippingMethod getShippingMethod(EntityPermission entityPermission) {
        ShippingMethodPK pk = getShippingMethodPK();
        ShippingMethod entity = pk == null? null: ShippingMethodFactory.getInstance().getEntityFromPK(entityPermission, pk);
        
        return entity;
    }
    
    @Nullable
    public ShippingMethod getShippingMethod() {
        return getShippingMethod(EntityPermission.READ_ONLY);
    }
    
    @Nullable
    public ShippingMethod getShippingMethodForUpdate() {
        return getShippingMethod(EntityPermission.READ_WRITE);
    }
    
    public void setShippingMethodPK(@Nullable ShippingMethodPK shippingMethodPK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setShippingMethodPK(shippingMethodPK);
    }
    
    public void setShippingMethod(@Nullable ShippingMethod entity) {
        setShippingMethodPK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getShippingMethodPKHasBeenModified() {
        return _value.getShippingMethodPKHasBeenModified();
    }
    
    @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();
    }
    
}