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

/**
 * OrderShipmentGroupDetail.java
 */

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

import com.echothree.model.data.order.common.pk.OrderShipmentGroupDetailPK;

import com.echothree.model.data.order.common.pk.OrderShipmentGroupPK;
import com.echothree.model.data.order.common.pk.OrderPK;
import com.echothree.model.data.item.common.pk.ItemDeliveryTypePK;
import com.echothree.model.data.contact.common.pk.PartyContactMechanismPK;
import com.echothree.model.data.shipping.common.pk.ShippingMethodPK;

import com.echothree.model.data.order.server.entity.OrderShipmentGroup;
import com.echothree.model.data.order.server.entity.Order;
import com.echothree.model.data.item.server.entity.ItemDeliveryType;
import com.echothree.model.data.contact.server.entity.PartyContactMechanism;
import com.echothree.model.data.shipping.server.entity.ShippingMethod;

import com.echothree.model.data.order.server.factory.OrderShipmentGroupFactory;
import com.echothree.model.data.order.server.factory.OrderFactory;
import com.echothree.model.data.item.server.factory.ItemDeliveryTypeFactory;
import com.echothree.model.data.contact.server.factory.PartyContactMechanismFactory;
import com.echothree.model.data.shipping.server.factory.ShippingMethodFactory;

import com.echothree.model.data.order.common.pk.OrderShipmentGroupDetailPK;

import com.echothree.model.data.order.server.value.OrderShipmentGroupDetailValue;

import com.echothree.model.data.order.server.factory.OrderShipmentGroupDetailFactory;

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 OrderShipmentGroupDetail
        extends BaseEntity
        implements Serializable {
    
    private OrderShipmentGroupDetailPK _pk;
    private OrderShipmentGroupDetailValue _value;
    
    /** Creates a new instance of OrderShipmentGroupDetail */
    public OrderShipmentGroupDetail()
            throws PersistenceException {
        super();
    }
    
    /** Creates a new instance of OrderShipmentGroupDetail */
    public OrderShipmentGroupDetail(OrderShipmentGroupDetailValue value, EntityPermission entityPermission) {
        super(entityPermission);
        
        _value = value;
        _pk = value.getPrimaryKey();
    }
    
    @Override
    @Nonnull
    public OrderShipmentGroupDetailFactory getBaseFactoryInstance() {
        return OrderShipmentGroupDetailFactory.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 OrderShipmentGroupDetail that) {
            OrderShipmentGroupDetailValue thatValue = that.getOrderShipmentGroupDetailValue();
            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 OrderShipmentGroupDetailValue getOrderShipmentGroupDetailValue() {
        return _value;
    }
    
    public void setOrderShipmentGroupDetailValue(@Nonnull OrderShipmentGroupDetailValue value)
            throws PersistenceReadOnlyException {
        checkReadWrite();
        _value = value;
    }
    
    @Override
    @Nonnull
    public OrderShipmentGroupDetailPK getPrimaryKey() {
        return _pk;
    }
    
    @Nonnull
    public OrderShipmentGroupPK getOrderShipmentGroupPK() {
        return _value.getOrderShipmentGroupPK();
    }
    
    @Nonnull
    public OrderShipmentGroup getOrderShipmentGroup(EntityPermission entityPermission) {
        return OrderShipmentGroupFactory.getInstance().getEntityFromPK(entityPermission, getOrderShipmentGroupPK());
    }
    
    @Nonnull
    public OrderShipmentGroup getOrderShipmentGroup() {
        return getOrderShipmentGroup(EntityPermission.READ_ONLY);
    }
    
    @Nonnull
    public OrderShipmentGroup getOrderShipmentGroupForUpdate() {
        return getOrderShipmentGroup(EntityPermission.READ_WRITE);
    }
    
    public void setOrderShipmentGroupPK(@Nonnull OrderShipmentGroupPK orderShipmentGroupPK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setOrderShipmentGroupPK(orderShipmentGroupPK);
    }
    
    public void setOrderShipmentGroup(@Nonnull OrderShipmentGroup entity) {
        setOrderShipmentGroupPK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getOrderShipmentGroupPKHasBeenModified() {
        return _value.getOrderShipmentGroupPKHasBeenModified();
    }
    
    @Nonnull
    public OrderPK getOrderPK() {
        return _value.getOrderPK();
    }
    
    @Nonnull
    public Order getOrder(EntityPermission entityPermission) {
        return OrderFactory.getInstance().getEntityFromPK(entityPermission, getOrderPK());
    }
    
    @Nonnull
    public Order getOrder() {
        return getOrder(EntityPermission.READ_ONLY);
    }
    
    @Nonnull
    public Order getOrderForUpdate() {
        return getOrder(EntityPermission.READ_WRITE);
    }
    
    public void setOrderPK(@Nonnull OrderPK orderPK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setOrderPK(orderPK);
    }
    
    public void setOrder(@Nonnull Order entity) {
        setOrderPK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getOrderPKHasBeenModified() {
        return _value.getOrderPKHasBeenModified();
    }
    
    @Nonnull
    public Integer getOrderShipmentGroupSequence() {
        return _value.getOrderShipmentGroupSequence();
    }
    
    public void setOrderShipmentGroupSequence(@Nonnull Integer orderShipmentGroupSequence)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setOrderShipmentGroupSequence(orderShipmentGroupSequence);
    }
    
    public boolean getOrderShipmentGroupSequenceHasBeenModified() {
        return _value.getOrderShipmentGroupSequenceHasBeenModified();
    }
    
    @Nonnull
    public ItemDeliveryTypePK getItemDeliveryTypePK() {
        return _value.getItemDeliveryTypePK();
    }
    
    @Nonnull
    public ItemDeliveryType getItemDeliveryType(EntityPermission entityPermission) {
        return ItemDeliveryTypeFactory.getInstance().getEntityFromPK(entityPermission, getItemDeliveryTypePK());
    }
    
    @Nonnull
    public ItemDeliveryType getItemDeliveryType() {
        return getItemDeliveryType(EntityPermission.READ_ONLY);
    }
    
    @Nonnull
    public ItemDeliveryType getItemDeliveryTypeForUpdate() {
        return getItemDeliveryType(EntityPermission.READ_WRITE);
    }
    
    public void setItemDeliveryTypePK(@Nonnull ItemDeliveryTypePK itemDeliveryTypePK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setItemDeliveryTypePK(itemDeliveryTypePK);
    }
    
    public void setItemDeliveryType(@Nonnull ItemDeliveryType entity) {
        setItemDeliveryTypePK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getItemDeliveryTypePKHasBeenModified() {
        return _value.getItemDeliveryTypePKHasBeenModified();
    }
    
    @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();
    }
    
    @Nullable
    public PartyContactMechanismPK getPartyContactMechanismPK() {
        return _value.getPartyContactMechanismPK();
    }
    
    @Nullable
    public PartyContactMechanism getPartyContactMechanism(EntityPermission entityPermission) {
        PartyContactMechanismPK pk = getPartyContactMechanismPK();
        PartyContactMechanism entity = pk == null? null: PartyContactMechanismFactory.getInstance().getEntityFromPK(entityPermission, pk);
        
        return entity;
    }
    
    @Nullable
    public PartyContactMechanism getPartyContactMechanism() {
        return getPartyContactMechanism(EntityPermission.READ_ONLY);
    }
    
    @Nullable
    public PartyContactMechanism getPartyContactMechanismForUpdate() {
        return getPartyContactMechanism(EntityPermission.READ_WRITE);
    }
    
    public void setPartyContactMechanismPK(@Nullable PartyContactMechanismPK partyContactMechanismPK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setPartyContactMechanismPK(partyContactMechanismPK);
    }
    
    public void setPartyContactMechanism(@Nullable PartyContactMechanism entity) {
        setPartyContactMechanismPK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getPartyContactMechanismPKHasBeenModified() {
        return _value.getPartyContactMechanismPKHasBeenModified();
    }
    
    @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();
    }
    
    @Nullable
    public Boolean getHoldUntilComplete() {
        return _value.getHoldUntilComplete();
    }
    
    public void setHoldUntilComplete(@Nullable Boolean holdUntilComplete)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setHoldUntilComplete(holdUntilComplete);
    }
    
    public boolean getHoldUntilCompleteHasBeenModified() {
        return _value.getHoldUntilCompleteHasBeenModified();
    }
    
    @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();
    }
    
}