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 * SalesOrderBatch.java
021 */
022
023package com.echothree.model.data.sales.server.entity;
024
025import com.echothree.model.data.sales.common.pk.SalesOrderBatchPK;
026
027import com.echothree.model.data.batch.common.pk.BatchPK;
028import com.echothree.model.data.payment.common.pk.PaymentMethodPK;
029
030import com.echothree.model.data.batch.server.entity.Batch;
031import com.echothree.model.data.payment.server.entity.PaymentMethod;
032
033import com.echothree.model.data.batch.server.factory.BatchFactory;
034import com.echothree.model.data.payment.server.factory.PaymentMethodFactory;
035
036import com.echothree.model.data.sales.common.pk.SalesOrderBatchPK;
037
038import com.echothree.model.data.sales.server.value.SalesOrderBatchValue;
039
040import com.echothree.model.data.sales.server.factory.SalesOrderBatchFactory;
041
042import com.echothree.util.common.exception.PersistenceException;
043import com.echothree.util.common.exception.PersistenceDatabaseException;
044import com.echothree.util.common.exception.PersistenceNotNullException;
045import com.echothree.util.common.exception.PersistenceReadOnlyException;
046
047import com.echothree.util.common.persistence.BasePK;
048
049import com.echothree.util.common.persistence.type.ByteArray;
050
051import com.echothree.util.server.persistence.BaseEntity;
052import com.echothree.util.server.persistence.EntityPermission;
053import com.echothree.util.server.persistence.Session;
054import com.echothree.util.server.persistence.ThreadSession;
055
056import java.io.Serializable;
057
058public class SalesOrderBatch
059        extends BaseEntity
060        implements Serializable {
061    
062    private SalesOrderBatchPK _pk;
063    private SalesOrderBatchValue _value;
064    
065    /** Creates a new instance of SalesOrderBatch */
066    public SalesOrderBatch()
067            throws PersistenceException {
068        super();
069    }
070    
071    /** Creates a new instance of SalesOrderBatch */
072    public SalesOrderBatch(SalesOrderBatchValue value, EntityPermission entityPermission) {
073        super(entityPermission);
074        
075        _value = value;
076        _pk = value.getPrimaryKey();
077    }
078    
079    @Override
080    public SalesOrderBatchFactory getBaseFactoryInstance() {
081        return SalesOrderBatchFactory.getInstance();
082    }
083    
084    @Override
085    public boolean hasBeenModified() {
086        return _value.hasBeenModified();
087    }
088    
089    @Override
090    public int hashCode() {
091        return _pk.hashCode();
092    }
093    
094    @Override
095    public String toString() {
096        return _pk.toString();
097    }
098    
099    @Override
100    public boolean equals(Object other) {
101        if(this == other)
102            return true;
103        
104        if(other instanceof SalesOrderBatch) {
105            SalesOrderBatch that = (SalesOrderBatch)other;
106            
107            SalesOrderBatchValue thatValue = that.getSalesOrderBatchValue();
108            return _value.equals(thatValue);
109        } else {
110            return false;
111        }
112    }
113    
114    @Override
115    public void store(Session session)
116            throws PersistenceDatabaseException {
117        getBaseFactoryInstance().store(session, this);
118    }
119    
120    @Override
121    public void remove(Session session)
122            throws PersistenceDatabaseException {
123        getBaseFactoryInstance().remove(session, this);
124    }
125    
126    @Override
127    public void remove()
128            throws PersistenceDatabaseException {
129        getBaseFactoryInstance().remove(ThreadSession.currentSession(), this);
130    }
131    
132    public SalesOrderBatchValue getSalesOrderBatchValue() {
133        return _value;
134    }
135    
136    public void setSalesOrderBatchValue(SalesOrderBatchValue value)
137            throws PersistenceReadOnlyException {
138        checkReadWrite();
139        _value = value;
140    }
141    
142    @Override
143    public SalesOrderBatchPK getPrimaryKey() {
144        return _pk;
145    }
146    
147    public BatchPK getBatchPK() {
148        return _value.getBatchPK();
149    }
150    
151    public Batch getBatch(Session session, EntityPermission entityPermission) {
152        return BatchFactory.getInstance().getEntityFromPK(session, entityPermission, getBatchPK());
153    }
154    
155    public Batch getBatch(EntityPermission entityPermission) {
156        return getBatch(ThreadSession.currentSession(), entityPermission);
157    }
158    
159    public Batch getBatch(Session session) {
160        return getBatch(session, EntityPermission.READ_ONLY);
161    }
162    
163    public Batch getBatch() {
164        return getBatch(ThreadSession.currentSession(), EntityPermission.READ_ONLY);
165    }
166    
167    public Batch getBatchForUpdate(Session session) {
168        return getBatch(session, EntityPermission.READ_WRITE);
169    }
170    
171    public Batch getBatchForUpdate() {
172        return getBatch(ThreadSession.currentSession(), EntityPermission.READ_WRITE);
173    }
174    
175    public void setBatchPK(BatchPK batchPK)
176            throws PersistenceNotNullException, PersistenceReadOnlyException {
177        checkReadWrite();
178        _value.setBatchPK(batchPK);
179    }
180    
181    public void setBatch(Batch entity) {
182        setBatchPK(entity == null? null: entity.getPrimaryKey());
183    }
184    
185    public boolean getBatchPKHasBeenModified() {
186        return _value.getBatchPKHasBeenModified();
187    }
188    
189    public PaymentMethodPK getPaymentMethodPK() {
190        return _value.getPaymentMethodPK();
191    }
192    
193    public PaymentMethod getPaymentMethod(Session session, EntityPermission entityPermission) {
194        return PaymentMethodFactory.getInstance().getEntityFromPK(session, entityPermission, getPaymentMethodPK());
195    }
196    
197    public PaymentMethod getPaymentMethod(EntityPermission entityPermission) {
198        return getPaymentMethod(ThreadSession.currentSession(), entityPermission);
199    }
200    
201    public PaymentMethod getPaymentMethod(Session session) {
202        return getPaymentMethod(session, EntityPermission.READ_ONLY);
203    }
204    
205    public PaymentMethod getPaymentMethod() {
206        return getPaymentMethod(ThreadSession.currentSession(), EntityPermission.READ_ONLY);
207    }
208    
209    public PaymentMethod getPaymentMethodForUpdate(Session session) {
210        return getPaymentMethod(session, EntityPermission.READ_WRITE);
211    }
212    
213    public PaymentMethod getPaymentMethodForUpdate() {
214        return getPaymentMethod(ThreadSession.currentSession(), EntityPermission.READ_WRITE);
215    }
216    
217    public void setPaymentMethodPK(PaymentMethodPK paymentMethodPK)
218            throws PersistenceNotNullException, PersistenceReadOnlyException {
219        checkReadWrite();
220        _value.setPaymentMethodPK(paymentMethodPK);
221    }
222    
223    public void setPaymentMethod(PaymentMethod entity) {
224        setPaymentMethodPK(entity == null? null: entity.getPrimaryKey());
225    }
226    
227    public boolean getPaymentMethodPKHasBeenModified() {
228        return _value.getPaymentMethodPKHasBeenModified();
229    }
230    
231    public Long getFromTime() {
232        return _value.getFromTime();
233    }
234    
235    public void setFromTime(Long fromTime)
236            throws PersistenceNotNullException, PersistenceReadOnlyException {
237        checkReadWrite();
238        _value.setFromTime(fromTime);
239    }
240    
241    public boolean getFromTimeHasBeenModified() {
242        return _value.getFromTimeHasBeenModified();
243    }
244    
245    public Long getThruTime() {
246        return _value.getThruTime();
247    }
248    
249    public void setThruTime(Long thruTime)
250            throws PersistenceNotNullException, PersistenceReadOnlyException {
251        checkReadWrite();
252        _value.setThruTime(thruTime);
253    }
254    
255    public boolean getThruTimeHasBeenModified() {
256        return _value.getThruTimeHasBeenModified();
257    }
258    
259}