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

/**
 * ItemShippingTime.java
 */

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

import com.echothree.model.data.item.common.pk.ItemShippingTimePK;

import com.echothree.model.data.item.common.pk.ItemPK;
import com.echothree.model.data.customer.common.pk.CustomerTypePK;

import com.echothree.model.data.item.server.entity.Item;
import com.echothree.model.data.customer.server.entity.CustomerType;

import com.echothree.model.data.item.server.factory.ItemFactory;
import com.echothree.model.data.customer.server.factory.CustomerTypeFactory;

import com.echothree.model.data.item.common.pk.ItemShippingTimePK;

import com.echothree.model.data.item.server.value.ItemShippingTimeValue;

import com.echothree.model.data.item.server.factory.ItemShippingTimeFactory;

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 ItemShippingTime
        extends BaseEntity
        implements Serializable {
    
    private ItemShippingTimePK _pk;
    private ItemShippingTimeValue _value;
    
    /** Creates a new instance of ItemShippingTime */
    public ItemShippingTime()
            throws PersistenceException {
        super();
    }
    
    /** Creates a new instance of ItemShippingTime */
    public ItemShippingTime(ItemShippingTimeValue value, EntityPermission entityPermission) {
        super(entityPermission);
        
        _value = value;
        _pk = value.getPrimaryKey();
    }
    
    @Override
    @Nonnull
    public ItemShippingTimeFactory getBaseFactoryInstance() {
        return ItemShippingTimeFactory.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 ItemShippingTime that) {
            ItemShippingTimeValue thatValue = that.getItemShippingTimeValue();
            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 ItemShippingTimeValue getItemShippingTimeValue() {
        return _value;
    }
    
    public void setItemShippingTimeValue(@Nonnull ItemShippingTimeValue value)
            throws PersistenceReadOnlyException {
        checkReadWrite();
        _value = value;
    }
    
    @Override
    @Nonnull
    public ItemShippingTimePK getPrimaryKey() {
        return _pk;
    }
    
    @Nonnull
    public ItemPK getItemPK() {
        return _value.getItemPK();
    }
    
    @Nonnull
    public Item getItem(EntityPermission entityPermission) {
        return ItemFactory.getInstance().getEntityFromPK(entityPermission, getItemPK());
    }
    
    @Nonnull
    public Item getItem() {
        return getItem(EntityPermission.READ_ONLY);
    }
    
    @Nonnull
    public Item getItemForUpdate() {
        return getItem(EntityPermission.READ_WRITE);
    }
    
    public void setItemPK(@Nonnull ItemPK itemPK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setItemPK(itemPK);
    }
    
    public void setItem(@Nonnull Item entity) {
        setItemPK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getItemPKHasBeenModified() {
        return _value.getItemPKHasBeenModified();
    }
    
    @Nonnull
    public CustomerTypePK getCustomerTypePK() {
        return _value.getCustomerTypePK();
    }
    
    @Nonnull
    public CustomerType getCustomerType(EntityPermission entityPermission) {
        return CustomerTypeFactory.getInstance().getEntityFromPK(entityPermission, getCustomerTypePK());
    }
    
    @Nonnull
    public CustomerType getCustomerType() {
        return getCustomerType(EntityPermission.READ_ONLY);
    }
    
    @Nonnull
    public CustomerType getCustomerTypeForUpdate() {
        return getCustomerType(EntityPermission.READ_WRITE);
    }
    
    public void setCustomerTypePK(@Nonnull CustomerTypePK customerTypePK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setCustomerTypePK(customerTypePK);
    }
    
    public void setCustomerType(@Nonnull CustomerType entity) {
        setCustomerTypePK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getCustomerTypePKHasBeenModified() {
        return _value.getCustomerTypePKHasBeenModified();
    }
    
    @Nonnull
    public Long getShippingStartTime() {
        return _value.getShippingStartTime();
    }
    
    public void setShippingStartTime(@Nonnull Long shippingStartTime)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setShippingStartTime(shippingStartTime);
    }
    
    public boolean getShippingStartTimeHasBeenModified() {
        return _value.getShippingStartTimeHasBeenModified();
    }
    
    @Nullable
    public Long getShippingEndTime() {
        return _value.getShippingEndTime();
    }
    
    public void setShippingEndTime(@Nullable Long shippingEndTime)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setShippingEndTime(shippingEndTime);
    }
    
    public boolean getShippingEndTimeHasBeenModified() {
        return _value.getShippingEndTimeHasBeenModified();
    }
    
    @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();
    }
    
}