001// --------------------------------------------------------------------------------
002// Copyright 2002-2024 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) {
102            ShipmentStatus that = (ShipmentStatus)other;
103            
104            ShipmentStatusValue thatValue = that.getShipmentStatusValue();
105            return _value.equals(thatValue);
106        } else {
107            return false;
108        }
109    }
110    
111    @Override
112    public void store(Session session)
113            throws PersistenceDatabaseException {
114        getBaseFactoryInstance().store(session, this);
115    }
116    
117    @Override
118    public void remove(Session session)
119            throws PersistenceDatabaseException {
120        getBaseFactoryInstance().remove(session, this);
121    }
122    
123    @Override
124    public void remove()
125            throws PersistenceDatabaseException {
126        getBaseFactoryInstance().remove(ThreadSession.currentSession(), this);
127    }
128    
129    public ShipmentStatusValue getShipmentStatusValue() {
130        return _value;
131    }
132    
133    public void setShipmentStatusValue(ShipmentStatusValue value)
134            throws PersistenceReadOnlyException {
135        checkReadWrite();
136        _value = value;
137    }
138    
139    @Override
140    public ShipmentStatusPK getPrimaryKey() {
141        return _pk;
142    }
143    
144    public ShipmentPK getShipmentPK() {
145        return _value.getShipmentPK();
146    }
147    
148    public Shipment getShipment(Session session, EntityPermission entityPermission) {
149        return ShipmentFactory.getInstance().getEntityFromPK(session, entityPermission, getShipmentPK());
150    }
151    
152    public Shipment getShipment(EntityPermission entityPermission) {
153        return getShipment(ThreadSession.currentSession(), entityPermission);
154    }
155    
156    public Shipment getShipment(Session session) {
157        return getShipment(session, EntityPermission.READ_ONLY);
158    }
159    
160    public Shipment getShipment() {
161        return getShipment(ThreadSession.currentSession(), EntityPermission.READ_ONLY);
162    }
163    
164    public Shipment getShipmentForUpdate(Session session) {
165        return getShipment(session, EntityPermission.READ_WRITE);
166    }
167    
168    public Shipment getShipmentForUpdate() {
169        return getShipment(ThreadSession.currentSession(), EntityPermission.READ_WRITE);
170    }
171    
172    public void setShipmentPK(ShipmentPK shipmentPK)
173            throws PersistenceNotNullException, PersistenceReadOnlyException {
174        checkReadWrite();
175        _value.setShipmentPK(shipmentPK);
176    }
177    
178    public void setShipment(Shipment entity) {
179        setShipmentPK(entity == null? null: entity.getPrimaryKey());
180    }
181    
182    public boolean getShipmentPKHasBeenModified() {
183        return _value.getShipmentPKHasBeenModified();
184    }
185    
186    public Integer getShipmentLineSequence() {
187        return _value.getShipmentLineSequence();
188    }
189    
190    public void setShipmentLineSequence(Integer shipmentLineSequence)
191            throws PersistenceNotNullException, PersistenceReadOnlyException {
192        checkReadWrite();
193        _value.setShipmentLineSequence(shipmentLineSequence);
194    }
195    
196    public boolean getShipmentLineSequenceHasBeenModified() {
197        return _value.getShipmentLineSequenceHasBeenModified();
198    }
199    
200}