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

/**
 * ShipmentTime.java
 */

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

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

import com.echothree.model.data.shipment.common.pk.ShipmentPK;
import com.echothree.model.data.shipment.common.pk.ShipmentTimeTypePK;

import com.echothree.model.data.shipment.server.entity.Shipment;
import com.echothree.model.data.shipment.server.entity.ShipmentTimeType;

import com.echothree.model.data.shipment.server.factory.ShipmentFactory;
import com.echothree.model.data.shipment.server.factory.ShipmentTimeTypeFactory;

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

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

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

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 ShipmentTime
        extends BaseEntity
        implements Serializable {
    
    private ShipmentTimePK _pk;
    private ShipmentTimeValue _value;
    
    /** Creates a new instance of ShipmentTime */
    public ShipmentTime()
            throws PersistenceException {
        super();
    }
    
    /** Creates a new instance of ShipmentTime */
    public ShipmentTime(ShipmentTimeValue value, EntityPermission entityPermission) {
        super(entityPermission);
        
        _value = value;
        _pk = value.getPrimaryKey();
    }
    
    @Override
    @Nonnull
    public ShipmentTimeFactory getBaseFactoryInstance() {
        return ShipmentTimeFactory.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 ShipmentTime that) {
            ShipmentTimeValue thatValue = that.getShipmentTimeValue();
            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 ShipmentTimeValue getShipmentTimeValue() {
        return _value;
    }
    
    public void setShipmentTimeValue(@Nonnull ShipmentTimeValue value)
            throws PersistenceReadOnlyException {
        checkReadWrite();
        _value = value;
    }
    
    @Override
    @Nonnull
    public ShipmentTimePK 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 ShipmentTimeTypePK getShipmentTimeTypePK() {
        return _value.getShipmentTimeTypePK();
    }
    
    @Nonnull
    public ShipmentTimeType getShipmentTimeType(EntityPermission entityPermission) {
        return ShipmentTimeTypeFactory.getInstance().getEntityFromPK(entityPermission, getShipmentTimeTypePK());
    }
    
    @Nonnull
    public ShipmentTimeType getShipmentTimeType() {
        return getShipmentTimeType(EntityPermission.READ_ONLY);
    }
    
    @Nonnull
    public ShipmentTimeType getShipmentTimeTypeForUpdate() {
        return getShipmentTimeType(EntityPermission.READ_WRITE);
    }
    
    public void setShipmentTimeTypePK(@Nonnull ShipmentTimeTypePK shipmentTimeTypePK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setShipmentTimeTypePK(shipmentTimeTypePK);
    }
    
    public void setShipmentTimeType(@Nonnull ShipmentTimeType entity) {
        setShipmentTimeTypePK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getShipmentTimeTypePKHasBeenModified() {
        return _value.getShipmentTimeTypePKHasBeenModified();
    }
    
    @Nonnull
    public Long getTime() {
        return _value.getTime();
    }
    
    public void setTime(@Nonnull Long time)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setTime(time);
    }
    
    public boolean getTimeHasBeenModified() {
        return _value.getTimeHasBeenModified();
    }
    
    @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();
    }
    
}