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 * OrderStatus.java
021 */
022
023package com.echothree.model.data.order.server.entity;
024
025import com.echothree.model.data.order.common.pk.OrderStatusPK;
026
027import com.echothree.model.data.order.common.pk.OrderPK;
028
029import com.echothree.model.data.order.server.entity.Order;
030
031import com.echothree.model.data.order.server.factory.OrderFactory;
032
033import com.echothree.model.data.order.common.pk.OrderStatusPK;
034
035import com.echothree.model.data.order.server.value.OrderStatusValue;
036
037import com.echothree.model.data.order.server.factory.OrderStatusFactory;
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 OrderStatus
056        extends BaseEntity
057        implements Serializable {
058    
059    private OrderStatusPK _pk;
060    private OrderStatusValue _value;
061    
062    /** Creates a new instance of OrderStatus */
063    public OrderStatus()
064            throws PersistenceException {
065        super();
066    }
067    
068    /** Creates a new instance of OrderStatus */
069    public OrderStatus(OrderStatusValue value, EntityPermission entityPermission) {
070        super(entityPermission);
071        
072        _value = value;
073        _pk = value.getPrimaryKey();
074    }
075    
076    @Override
077    public OrderStatusFactory getBaseFactoryInstance() {
078        return OrderStatusFactory.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 OrderStatus that) {
102            OrderStatusValue thatValue = that.getOrderStatusValue();
103            return _value.equals(thatValue);
104        } else {
105            return false;
106        }
107    }
108    
109    @Override
110    public void store()
111            throws PersistenceDatabaseException {
112        getBaseFactoryInstance().store(this);
113    }
114    
115    @Override
116    public void remove()
117            throws PersistenceDatabaseException {
118        getBaseFactoryInstance().remove(this);
119    }
120    
121    public OrderStatusValue getOrderStatusValue() {
122        return _value;
123    }
124    
125    public void setOrderStatusValue(OrderStatusValue value)
126            throws PersistenceReadOnlyException {
127        checkReadWrite();
128        _value = value;
129    }
130    
131    @Override
132    public OrderStatusPK getPrimaryKey() {
133        return _pk;
134    }
135    
136    public OrderPK getOrderPK() {
137        return _value.getOrderPK();
138    }
139    
140    public Order getOrder(EntityPermission entityPermission) {
141        return OrderFactory.getInstance().getEntityFromPK(entityPermission, getOrderPK());
142    }
143    
144    public Order getOrder() {
145        return getOrder(EntityPermission.READ_ONLY);
146    }
147    
148    public Order getOrderForUpdate() {
149        return getOrder(EntityPermission.READ_WRITE);
150    }
151    
152    public void setOrderPK(OrderPK orderPK)
153            throws PersistenceNotNullException, PersistenceReadOnlyException {
154        checkReadWrite();
155        _value.setOrderPK(orderPK);
156    }
157    
158    public void setOrder(Order entity) {
159        setOrderPK(entity == null? null: entity.getPrimaryKey());
160    }
161    
162    public boolean getOrderPKHasBeenModified() {
163        return _value.getOrderPKHasBeenModified();
164    }
165    
166    public Integer getOrderShipmentGroupSequence() {
167        return _value.getOrderShipmentGroupSequence();
168    }
169    
170    public void setOrderShipmentGroupSequence(Integer orderShipmentGroupSequence)
171            throws PersistenceNotNullException, PersistenceReadOnlyException {
172        checkReadWrite();
173        _value.setOrderShipmentGroupSequence(orderShipmentGroupSequence);
174    }
175    
176    public boolean getOrderShipmentGroupSequenceHasBeenModified() {
177        return _value.getOrderShipmentGroupSequenceHasBeenModified();
178    }
179    
180    public Integer getOrderLineSequence() {
181        return _value.getOrderLineSequence();
182    }
183    
184    public void setOrderLineSequence(Integer orderLineSequence)
185            throws PersistenceNotNullException, PersistenceReadOnlyException {
186        checkReadWrite();
187        _value.setOrderLineSequence(orderLineSequence);
188    }
189    
190    public boolean getOrderLineSequenceHasBeenModified() {
191        return _value.getOrderLineSequenceHasBeenModified();
192    }
193    
194    public Integer getOrderAdjustmentSequence() {
195        return _value.getOrderAdjustmentSequence();
196    }
197    
198    public void setOrderAdjustmentSequence(Integer orderAdjustmentSequence)
199            throws PersistenceNotNullException, PersistenceReadOnlyException {
200        checkReadWrite();
201        _value.setOrderAdjustmentSequence(orderAdjustmentSequence);
202    }
203    
204    public boolean getOrderAdjustmentSequenceHasBeenModified() {
205        return _value.getOrderAdjustmentSequenceHasBeenModified();
206    }
207    
208    public Integer getOrderPaymentPreferenceSequence() {
209        return _value.getOrderPaymentPreferenceSequence();
210    }
211    
212    public void setOrderPaymentPreferenceSequence(Integer orderPaymentPreferenceSequence)
213            throws PersistenceNotNullException, PersistenceReadOnlyException {
214        checkReadWrite();
215        _value.setOrderPaymentPreferenceSequence(orderPaymentPreferenceSequence);
216    }
217    
218    public boolean getOrderPaymentPreferenceSequenceHasBeenModified() {
219        return _value.getOrderPaymentPreferenceSequenceHasBeenModified();
220    }
221    
222}