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 * SalesOrder.java
021 */
022
023package com.echothree.model.data.sales.server.entity;
024
025import com.echothree.model.data.sales.common.pk.SalesOrderPK;
026
027import com.echothree.model.data.order.common.pk.OrderPK;
028import com.echothree.model.data.offer.common.pk.OfferUsePK;
029import com.echothree.model.data.associate.common.pk.AssociateReferralPK;
030
031import com.echothree.model.data.order.server.entity.Order;
032import com.echothree.model.data.offer.server.entity.OfferUse;
033import com.echothree.model.data.associate.server.entity.AssociateReferral;
034
035import com.echothree.model.data.order.server.factory.OrderFactory;
036import com.echothree.model.data.offer.server.factory.OfferUseFactory;
037import com.echothree.model.data.associate.server.factory.AssociateReferralFactory;
038
039import com.echothree.model.data.sales.common.pk.SalesOrderPK;
040
041import com.echothree.model.data.sales.server.value.SalesOrderValue;
042
043import com.echothree.model.data.sales.server.factory.SalesOrderFactory;
044
045import com.echothree.util.common.exception.PersistenceException;
046import com.echothree.util.common.exception.PersistenceDatabaseException;
047import com.echothree.util.common.exception.PersistenceNotNullException;
048import com.echothree.util.common.exception.PersistenceReadOnlyException;
049
050import com.echothree.util.common.persistence.BasePK;
051
052import com.echothree.util.common.persistence.type.ByteArray;
053
054import com.echothree.util.server.persistence.BaseEntity;
055import com.echothree.util.server.persistence.EntityPermission;
056import com.echothree.util.server.persistence.Session;
057import com.echothree.util.server.persistence.ThreadSession;
058
059import java.io.Serializable;
060
061public class SalesOrder
062        extends BaseEntity
063        implements Serializable {
064    
065    private SalesOrderPK _pk;
066    private SalesOrderValue _value;
067    
068    /** Creates a new instance of SalesOrder */
069    public SalesOrder()
070            throws PersistenceException {
071        super();
072    }
073    
074    /** Creates a new instance of SalesOrder */
075    public SalesOrder(SalesOrderValue value, EntityPermission entityPermission) {
076        super(entityPermission);
077        
078        _value = value;
079        _pk = value.getPrimaryKey();
080    }
081    
082    @Override
083    public SalesOrderFactory getBaseFactoryInstance() {
084        return SalesOrderFactory.getInstance();
085    }
086    
087    @Override
088    public boolean hasBeenModified() {
089        return _value.hasBeenModified();
090    }
091    
092    @Override
093    public int hashCode() {
094        return _pk.hashCode();
095    }
096    
097    @Override
098    public String toString() {
099        return _pk.toString();
100    }
101    
102    @Override
103    public boolean equals(Object other) {
104        if(this == other)
105            return true;
106        
107        if(other instanceof SalesOrder) {
108            SalesOrder that = (SalesOrder)other;
109            
110            SalesOrderValue thatValue = that.getSalesOrderValue();
111            return _value.equals(thatValue);
112        } else {
113            return false;
114        }
115    }
116    
117    @Override
118    public void store(Session session)
119            throws PersistenceDatabaseException {
120        getBaseFactoryInstance().store(session, this);
121    }
122    
123    @Override
124    public void remove(Session session)
125            throws PersistenceDatabaseException {
126        getBaseFactoryInstance().remove(session, this);
127    }
128    
129    @Override
130    public void remove()
131            throws PersistenceDatabaseException {
132        getBaseFactoryInstance().remove(ThreadSession.currentSession(), this);
133    }
134    
135    public SalesOrderValue getSalesOrderValue() {
136        return _value;
137    }
138    
139    public void setSalesOrderValue(SalesOrderValue value)
140            throws PersistenceReadOnlyException {
141        checkReadWrite();
142        _value = value;
143    }
144    
145    @Override
146    public SalesOrderPK getPrimaryKey() {
147        return _pk;
148    }
149    
150    public OrderPK getOrderPK() {
151        return _value.getOrderPK();
152    }
153    
154    public Order getOrder(Session session, EntityPermission entityPermission) {
155        return OrderFactory.getInstance().getEntityFromPK(session, entityPermission, getOrderPK());
156    }
157    
158    public Order getOrder(EntityPermission entityPermission) {
159        return getOrder(ThreadSession.currentSession(), entityPermission);
160    }
161    
162    public Order getOrder(Session session) {
163        return getOrder(session, EntityPermission.READ_ONLY);
164    }
165    
166    public Order getOrder() {
167        return getOrder(ThreadSession.currentSession(), EntityPermission.READ_ONLY);
168    }
169    
170    public Order getOrderForUpdate(Session session) {
171        return getOrder(session, EntityPermission.READ_WRITE);
172    }
173    
174    public Order getOrderForUpdate() {
175        return getOrder(ThreadSession.currentSession(), EntityPermission.READ_WRITE);
176    }
177    
178    public void setOrderPK(OrderPK orderPK)
179            throws PersistenceNotNullException, PersistenceReadOnlyException {
180        checkReadWrite();
181        _value.setOrderPK(orderPK);
182    }
183    
184    public void setOrder(Order entity) {
185        setOrderPK(entity == null? null: entity.getPrimaryKey());
186    }
187    
188    public boolean getOrderPKHasBeenModified() {
189        return _value.getOrderPKHasBeenModified();
190    }
191    
192    public OfferUsePK getOfferUsePK() {
193        return _value.getOfferUsePK();
194    }
195    
196    public OfferUse getOfferUse(Session session, EntityPermission entityPermission) {
197        return OfferUseFactory.getInstance().getEntityFromPK(session, entityPermission, getOfferUsePK());
198    }
199    
200    public OfferUse getOfferUse(EntityPermission entityPermission) {
201        return getOfferUse(ThreadSession.currentSession(), entityPermission);
202    }
203    
204    public OfferUse getOfferUse(Session session) {
205        return getOfferUse(session, EntityPermission.READ_ONLY);
206    }
207    
208    public OfferUse getOfferUse() {
209        return getOfferUse(ThreadSession.currentSession(), EntityPermission.READ_ONLY);
210    }
211    
212    public OfferUse getOfferUseForUpdate(Session session) {
213        return getOfferUse(session, EntityPermission.READ_WRITE);
214    }
215    
216    public OfferUse getOfferUseForUpdate() {
217        return getOfferUse(ThreadSession.currentSession(), EntityPermission.READ_WRITE);
218    }
219    
220    public void setOfferUsePK(OfferUsePK offerUsePK)
221            throws PersistenceNotNullException, PersistenceReadOnlyException {
222        checkReadWrite();
223        _value.setOfferUsePK(offerUsePK);
224    }
225    
226    public void setOfferUse(OfferUse entity) {
227        setOfferUsePK(entity == null? null: entity.getPrimaryKey());
228    }
229    
230    public boolean getOfferUsePKHasBeenModified() {
231        return _value.getOfferUsePKHasBeenModified();
232    }
233    
234    public AssociateReferralPK getAssociateReferralPK() {
235        return _value.getAssociateReferralPK();
236    }
237    
238    public AssociateReferral getAssociateReferral(Session session, EntityPermission entityPermission) {
239        AssociateReferralPK pk = getAssociateReferralPK();
240        AssociateReferral entity = pk == null? null: AssociateReferralFactory.getInstance().getEntityFromPK(session, entityPermission, pk);
241        
242        return entity;
243    }
244    
245    public AssociateReferral getAssociateReferral(EntityPermission entityPermission) {
246        return getAssociateReferral(ThreadSession.currentSession(), entityPermission);
247    }
248    
249    public AssociateReferral getAssociateReferral(Session session) {
250        return getAssociateReferral(session, EntityPermission.READ_ONLY);
251    }
252    
253    public AssociateReferral getAssociateReferral() {
254        return getAssociateReferral(ThreadSession.currentSession(), EntityPermission.READ_ONLY);
255    }
256    
257    public AssociateReferral getAssociateReferralForUpdate(Session session) {
258        return getAssociateReferral(session, EntityPermission.READ_WRITE);
259    }
260    
261    public AssociateReferral getAssociateReferralForUpdate() {
262        return getAssociateReferral(ThreadSession.currentSession(), EntityPermission.READ_WRITE);
263    }
264    
265    public void setAssociateReferralPK(AssociateReferralPK associateReferralPK)
266            throws PersistenceNotNullException, PersistenceReadOnlyException {
267        checkReadWrite();
268        _value.setAssociateReferralPK(associateReferralPK);
269    }
270    
271    public void setAssociateReferral(AssociateReferral entity) {
272        setAssociateReferralPK(entity == null? null: entity.getPrimaryKey());
273    }
274    
275    public boolean getAssociateReferralPKHasBeenModified() {
276        return _value.getAssociateReferralPKHasBeenModified();
277    }
278    
279    public Long getFromTime() {
280        return _value.getFromTime();
281    }
282    
283    public void setFromTime(Long fromTime)
284            throws PersistenceNotNullException, PersistenceReadOnlyException {
285        checkReadWrite();
286        _value.setFromTime(fromTime);
287    }
288    
289    public boolean getFromTimeHasBeenModified() {
290        return _value.getFromTimeHasBeenModified();
291    }
292    
293    public Long getThruTime() {
294        return _value.getThruTime();
295    }
296    
297    public void setThruTime(Long thruTime)
298            throws PersistenceNotNullException, PersistenceReadOnlyException {
299        checkReadWrite();
300        _value.setThruTime(thruTime);
301    }
302    
303    public boolean getThruTimeHasBeenModified() {
304        return _value.getThruTimeHasBeenModified();
305    }
306    
307}