001// --------------------------------------------------------------------------------
002// Copyright 2002-2026 Echo Three, LLC
003//
004// Licensed under the Apache License, Version 2.0 (the "License");
005// you may not use this file except in compliance with the License.
006// You may obtain a copy of the License at
007//
008//     http://www.apache.org/licenses/LICENSE-2.0
009//
010// Unless required by applicable law or agreed to in writing, software
011// distributed under the License is distributed on an "AS IS" BASIS,
012// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013// See the License for the specific language governing permissions and
014// limitations under the License.
015// --------------------------------------------------------------------------------
016// Generated File -- DO NOT EDIT BY HAND
017// --------------------------------------------------------------------------------
018
019/**
020 * ShipmentStatus.java
021 */
022
023package com.echothree.model.data.shipment.server.entity;
024
025import com.echothree.model.data.shipment.common.pk.ShipmentStatusPK;
026
027import com.echothree.model.data.shipment.common.pk.ShipmentPK;
028
029import com.echothree.model.data.shipment.server.entity.Shipment;
030
031import com.echothree.model.data.shipment.server.factory.ShipmentFactory;
032
033import com.echothree.model.data.shipment.common.pk.ShipmentStatusPK;
034
035import com.echothree.model.data.shipment.server.value.ShipmentStatusValue;
036
037import com.echothree.model.data.shipment.server.factory.ShipmentStatusFactory;
038
039import com.echothree.util.common.exception.PersistenceException;
040import com.echothree.util.common.exception.PersistenceDatabaseException;
041import com.echothree.util.common.exception.PersistenceNotNullException;
042import com.echothree.util.common.exception.PersistenceReadOnlyException;
043
044import com.echothree.util.common.persistence.BasePK;
045
046import com.echothree.util.common.persistence.type.ByteArray;
047
048import com.echothree.util.server.persistence.BaseEntity;
049import com.echothree.util.server.persistence.EntityPermission;
050import com.echothree.util.server.persistence.Session;
051import com.echothree.util.server.persistence.ThreadSession;
052
053import java.io.Serializable;
054
055import javax.annotation.Nonnull;
056import javax.annotation.Nullable;
057
058public class ShipmentStatus
059        extends BaseEntity
060        implements Serializable {
061    
062    private ShipmentStatusPK _pk;
063    private ShipmentStatusValue _value;
064    
065    /** Creates a new instance of ShipmentStatus */
066    public ShipmentStatus()
067            throws PersistenceException {
068        super();
069    }
070    
071    /** Creates a new instance of ShipmentStatus */
072    public ShipmentStatus(ShipmentStatusValue value, EntityPermission entityPermission) {
073        super(entityPermission);
074        
075        _value = value;
076        _pk = value.getPrimaryKey();
077    }
078    
079    @Override
080    @Nonnull
081    public ShipmentStatusFactory getBaseFactoryInstance() {
082        return ShipmentStatusFactory.getInstance();
083    }
084    
085    @Override
086    public boolean hasBeenModified() {
087        return _value.hasBeenModified();
088    }
089    
090    @Override
091    public int hashCode() {
092        return _pk.hashCode();
093    }
094    
095    @Override
096    @Nonnull
097    public String toString() {
098        return _pk.toString();
099    }
100    
101    @Override
102    public boolean equals(Object other) {
103        if(this == other)
104            return true;
105        
106        if(other instanceof ShipmentStatus that) {
107            ShipmentStatusValue thatValue = that.getShipmentStatusValue();
108            return _value.equals(thatValue);
109        } else {
110            return false;
111        }
112    }
113    
114    @Override
115    public void store()
116            throws PersistenceDatabaseException {
117        getBaseFactoryInstance().store(this);
118    }
119    
120    @Override
121    public void remove()
122            throws PersistenceDatabaseException {
123        getBaseFactoryInstance().remove(this);
124    }
125    
126    @Nonnull
127    public ShipmentStatusValue getShipmentStatusValue() {
128        return _value;
129    }
130    
131    public void setShipmentStatusValue(@Nonnull ShipmentStatusValue value)
132            throws PersistenceReadOnlyException {
133        checkReadWrite();
134        _value = value;
135    }
136    
137    @Override
138    @Nonnull
139    public ShipmentStatusPK getPrimaryKey() {
140        return _pk;
141    }
142    
143    @Nonnull
144    public ShipmentPK getShipmentPK() {
145        return _value.getShipmentPK();
146    }
147    
148    @Nonnull
149    public Shipment getShipment(EntityPermission entityPermission) {
150        return ShipmentFactory.getInstance().getEntityFromPK(entityPermission, getShipmentPK());
151    }
152    
153    @Nonnull
154    public Shipment getShipment() {
155        return getShipment(EntityPermission.READ_ONLY);
156    }
157    
158    @Nonnull
159    public Shipment getShipmentForUpdate() {
160        return getShipment(EntityPermission.READ_WRITE);
161    }
162    
163    public void setShipmentPK(@Nonnull ShipmentPK shipmentPK)
164            throws PersistenceNotNullException, PersistenceReadOnlyException {
165        checkReadWrite();
166        _value.setShipmentPK(shipmentPK);
167    }
168    
169    public void setShipment(@Nonnull Shipment entity) {
170        setShipmentPK(entity == null ? null : entity.getPrimaryKey());
171    }
172    
173    public boolean getShipmentPKHasBeenModified() {
174        return _value.getShipmentPKHasBeenModified();
175    }
176    
177    @Nonnull
178    public Integer getShipmentLineSequence() {
179        return _value.getShipmentLineSequence();
180    }
181    
182    public void setShipmentLineSequence(@Nonnull Integer shipmentLineSequence)
183            throws PersistenceNotNullException, PersistenceReadOnlyException {
184        checkReadWrite();
185        _value.setShipmentLineSequence(shipmentLineSequence);
186    }
187    
188    public boolean getShipmentLineSequenceHasBeenModified() {
189        return _value.getShipmentLineSequenceHasBeenModified();
190    }
191    
192}