001// --------------------------------------------------------------------------------
002// Copyright 2002-2025 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
055public class ShipmentStatus
056        extends BaseEntity
057        implements Serializable {
058    
059    private ShipmentStatusPK _pk;
060    private ShipmentStatusValue _value;
061    
062    /** Creates a new instance of ShipmentStatus */
063    public ShipmentStatus()
064            throws PersistenceException {
065        super();
066    }
067    
068    /** Creates a new instance of ShipmentStatus */
069    public ShipmentStatus(ShipmentStatusValue value, EntityPermission entityPermission) {
070        super(entityPermission);
071        
072        _value = value;
073        _pk = value.getPrimaryKey();
074    }
075    
076    @Override
077    public ShipmentStatusFactory getBaseFactoryInstance() {
078        return ShipmentStatusFactory.getInstance();
079    }
080    
081    @Override
082    public boolean hasBeenModified() {
083        return _value.hasBeenModified();
084    }
085    
086    @Override
087    public int hashCode() {
088        return _pk.hashCode();
089    }
090    
091    @Override
092    public String toString() {
093        return _pk.toString();
094    }
095    
096    @Override
097    public boolean equals(Object other) {
098        if(this == other)
099            return true;
100        
101        if(other instanceof ShipmentStatus that) {
102            ShipmentStatusValue thatValue = that.getShipmentStatusValue();
103            return _value.equals(thatValue);
104        } else {
105            return false;
106        }
107    }
108    
109    @Override
110    public void store(Session session)
111            throws PersistenceDatabaseException {
112        getBaseFactoryInstance().store(session, this);
113    }
114    
115    @Override
116    public void remove(Session session)
117            throws PersistenceDatabaseException {
118        getBaseFactoryInstance().remove(session, this);
119    }
120    
121    @Override
122    public void remove()
123            throws PersistenceDatabaseException {
124        getBaseFactoryInstance().remove(ThreadSession.currentSession(), this);
125    }
126    
127    public ShipmentStatusValue getShipmentStatusValue() {
128        return _value;
129    }
130    
131    public void setShipmentStatusValue(ShipmentStatusValue value)
132            throws PersistenceReadOnlyException {
133        checkReadWrite();
134        _value = value;
135    }
136    
137    @Override
138    public ShipmentStatusPK getPrimaryKey() {
139        return _pk;
140    }
141    
142    public ShipmentPK getShipmentPK() {
143        return _value.getShipmentPK();
144    }
145    
146    public Shipment getShipment(Session session, EntityPermission entityPermission) {
147        return ShipmentFactory.getInstance().getEntityFromPK(session, entityPermission, getShipmentPK());
148    }
149    
150    public Shipment getShipment(EntityPermission entityPermission) {
151        return getShipment(ThreadSession.currentSession(), entityPermission);
152    }
153    
154    public Shipment getShipment(Session session) {
155        return getShipment(session, EntityPermission.READ_ONLY);
156    }
157    
158    public Shipment getShipment() {
159        return getShipment(ThreadSession.currentSession(), EntityPermission.READ_ONLY);
160    }
161    
162    public Shipment getShipmentForUpdate(Session session) {
163        return getShipment(session, EntityPermission.READ_WRITE);
164    }
165    
166    public Shipment getShipmentForUpdate() {
167        return getShipment(ThreadSession.currentSession(), EntityPermission.READ_WRITE);
168    }
169    
170    public void setShipmentPK(ShipmentPK shipmentPK)
171            throws PersistenceNotNullException, PersistenceReadOnlyException {
172        checkReadWrite();
173        _value.setShipmentPK(shipmentPK);
174    }
175    
176    public void setShipment(Shipment entity) {
177        setShipmentPK(entity == null? null: entity.getPrimaryKey());
178    }
179    
180    public boolean getShipmentPKHasBeenModified() {
181        return _value.getShipmentPKHasBeenModified();
182    }
183    
184    public Integer getShipmentLineSequence() {
185        return _value.getShipmentLineSequence();
186    }
187    
188    public void setShipmentLineSequence(Integer shipmentLineSequence)
189            throws PersistenceNotNullException, PersistenceReadOnlyException {
190        checkReadWrite();
191        _value.setShipmentLineSequence(shipmentLineSequence);
192    }
193    
194    public boolean getShipmentLineSequenceHasBeenModified() {
195        return _value.getShipmentLineSequenceHasBeenModified();
196    }
197    
198}