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 * PaymentDetail.java
021 */
022
023package com.echothree.model.data.payment.server.entity;
024
025import com.echothree.model.data.payment.common.pk.PaymentDetailPK;
026
027import com.echothree.model.data.payment.common.pk.PaymentPK;
028import com.echothree.model.data.payment.common.pk.PartyPaymentMethodPK;
029import com.echothree.model.data.accounting.common.pk.CurrencyPK;
030
031import com.echothree.model.data.payment.server.entity.Payment;
032import com.echothree.model.data.payment.server.entity.PartyPaymentMethod;
033import com.echothree.model.data.accounting.server.entity.Currency;
034
035import com.echothree.model.data.payment.server.factory.PaymentFactory;
036import com.echothree.model.data.payment.server.factory.PartyPaymentMethodFactory;
037import com.echothree.model.data.accounting.server.factory.CurrencyFactory;
038
039import com.echothree.model.data.payment.common.pk.PaymentDetailPK;
040
041import com.echothree.model.data.payment.server.value.PaymentDetailValue;
042
043import com.echothree.model.data.payment.server.factory.PaymentDetailFactory;
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 PaymentDetail
062        extends BaseEntity
063        implements Serializable {
064    
065    private PaymentDetailPK _pk;
066    private PaymentDetailValue _value;
067    
068    /** Creates a new instance of PaymentDetail */
069    public PaymentDetail()
070            throws PersistenceException {
071        super();
072    }
073    
074    /** Creates a new instance of PaymentDetail */
075    public PaymentDetail(PaymentDetailValue value, EntityPermission entityPermission) {
076        super(entityPermission);
077        
078        _value = value;
079        _pk = value.getPrimaryKey();
080    }
081    
082    @Override
083    public PaymentDetailFactory getBaseFactoryInstance() {
084        return PaymentDetailFactory.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 PaymentDetail that) {
108            PaymentDetailValue thatValue = that.getPaymentDetailValue();
109            return _value.equals(thatValue);
110        } else {
111            return false;
112        }
113    }
114    
115    @Override
116    public void store(Session session)
117            throws PersistenceDatabaseException {
118        getBaseFactoryInstance().store(session, this);
119    }
120    
121    @Override
122    public void remove(Session session)
123            throws PersistenceDatabaseException {
124        getBaseFactoryInstance().remove(session, this);
125    }
126    
127    @Override
128    public void remove()
129            throws PersistenceDatabaseException {
130        getBaseFactoryInstance().remove(ThreadSession.currentSession(), this);
131    }
132    
133    public PaymentDetailValue getPaymentDetailValue() {
134        return _value;
135    }
136    
137    public void setPaymentDetailValue(PaymentDetailValue value)
138            throws PersistenceReadOnlyException {
139        checkReadWrite();
140        _value = value;
141    }
142    
143    @Override
144    public PaymentDetailPK getPrimaryKey() {
145        return _pk;
146    }
147    
148    public PaymentPK getPaymentPK() {
149        return _value.getPaymentPK();
150    }
151    
152    public Payment getPayment(Session session, EntityPermission entityPermission) {
153        return PaymentFactory.getInstance().getEntityFromPK(session, entityPermission, getPaymentPK());
154    }
155    
156    public Payment getPayment(EntityPermission entityPermission) {
157        return getPayment(ThreadSession.currentSession(), entityPermission);
158    }
159    
160    public Payment getPayment(Session session) {
161        return getPayment(session, EntityPermission.READ_ONLY);
162    }
163    
164    public Payment getPayment() {
165        return getPayment(ThreadSession.currentSession(), EntityPermission.READ_ONLY);
166    }
167    
168    public Payment getPaymentForUpdate(Session session) {
169        return getPayment(session, EntityPermission.READ_WRITE);
170    }
171    
172    public Payment getPaymentForUpdate() {
173        return getPayment(ThreadSession.currentSession(), EntityPermission.READ_WRITE);
174    }
175    
176    public void setPaymentPK(PaymentPK paymentPK)
177            throws PersistenceNotNullException, PersistenceReadOnlyException {
178        checkReadWrite();
179        _value.setPaymentPK(paymentPK);
180    }
181    
182    public void setPayment(Payment entity) {
183        setPaymentPK(entity == null? null: entity.getPrimaryKey());
184    }
185    
186    public boolean getPaymentPKHasBeenModified() {
187        return _value.getPaymentPKHasBeenModified();
188    }
189    
190    public String getPaymentName() {
191        return _value.getPaymentName();
192    }
193    
194    public void setPaymentName(String paymentName)
195            throws PersistenceNotNullException, PersistenceReadOnlyException {
196        checkReadWrite();
197        _value.setPaymentName(paymentName);
198    }
199    
200    public boolean getPaymentNameHasBeenModified() {
201        return _value.getPaymentNameHasBeenModified();
202    }
203    
204    public PartyPaymentMethodPK getPartyPaymentMethodPK() {
205        return _value.getPartyPaymentMethodPK();
206    }
207    
208    public PartyPaymentMethod getPartyPaymentMethod(Session session, EntityPermission entityPermission) {
209        PartyPaymentMethodPK pk = getPartyPaymentMethodPK();
210        PartyPaymentMethod entity = pk == null? null: PartyPaymentMethodFactory.getInstance().getEntityFromPK(session, entityPermission, pk);
211        
212        return entity;
213    }
214    
215    public PartyPaymentMethod getPartyPaymentMethod(EntityPermission entityPermission) {
216        return getPartyPaymentMethod(ThreadSession.currentSession(), entityPermission);
217    }
218    
219    public PartyPaymentMethod getPartyPaymentMethod(Session session) {
220        return getPartyPaymentMethod(session, EntityPermission.READ_ONLY);
221    }
222    
223    public PartyPaymentMethod getPartyPaymentMethod() {
224        return getPartyPaymentMethod(ThreadSession.currentSession(), EntityPermission.READ_ONLY);
225    }
226    
227    public PartyPaymentMethod getPartyPaymentMethodForUpdate(Session session) {
228        return getPartyPaymentMethod(session, EntityPermission.READ_WRITE);
229    }
230    
231    public PartyPaymentMethod getPartyPaymentMethodForUpdate() {
232        return getPartyPaymentMethod(ThreadSession.currentSession(), EntityPermission.READ_WRITE);
233    }
234    
235    public void setPartyPaymentMethodPK(PartyPaymentMethodPK partyPaymentMethodPK)
236            throws PersistenceNotNullException, PersistenceReadOnlyException {
237        checkReadWrite();
238        _value.setPartyPaymentMethodPK(partyPaymentMethodPK);
239    }
240    
241    public void setPartyPaymentMethod(PartyPaymentMethod entity) {
242        setPartyPaymentMethodPK(entity == null? null: entity.getPrimaryKey());
243    }
244    
245    public boolean getPartyPaymentMethodPKHasBeenModified() {
246        return _value.getPartyPaymentMethodPKHasBeenModified();
247    }
248    
249    public CurrencyPK getCurrencyPK() {
250        return _value.getCurrencyPK();
251    }
252    
253    public Currency getCurrency(Session session, EntityPermission entityPermission) {
254        CurrencyPK pk = getCurrencyPK();
255        Currency entity = pk == null? null: CurrencyFactory.getInstance().getEntityFromPK(session, entityPermission, pk);
256        
257        return entity;
258    }
259    
260    public Currency getCurrency(EntityPermission entityPermission) {
261        return getCurrency(ThreadSession.currentSession(), entityPermission);
262    }
263    
264    public Currency getCurrency(Session session) {
265        return getCurrency(session, EntityPermission.READ_ONLY);
266    }
267    
268    public Currency getCurrency() {
269        return getCurrency(ThreadSession.currentSession(), EntityPermission.READ_ONLY);
270    }
271    
272    public Currency getCurrencyForUpdate(Session session) {
273        return getCurrency(session, EntityPermission.READ_WRITE);
274    }
275    
276    public Currency getCurrencyForUpdate() {
277        return getCurrency(ThreadSession.currentSession(), EntityPermission.READ_WRITE);
278    }
279    
280    public void setCurrencyPK(CurrencyPK currencyPK)
281            throws PersistenceNotNullException, PersistenceReadOnlyException {
282        checkReadWrite();
283        _value.setCurrencyPK(currencyPK);
284    }
285    
286    public void setCurrency(Currency entity) {
287        setCurrencyPK(entity == null? null: entity.getPrimaryKey());
288    }
289    
290    public boolean getCurrencyPKHasBeenModified() {
291        return _value.getCurrencyPKHasBeenModified();
292    }
293    
294    public Long getAmount() {
295        return _value.getAmount();
296    }
297    
298    public void setAmount(Long amount)
299            throws PersistenceNotNullException, PersistenceReadOnlyException {
300        checkReadWrite();
301        _value.setAmount(amount);
302    }
303    
304    public boolean getAmountHasBeenModified() {
305        return _value.getAmountHasBeenModified();
306    }
307    
308    public Long getFromTime() {
309        return _value.getFromTime();
310    }
311    
312    public void setFromTime(Long fromTime)
313            throws PersistenceNotNullException, PersistenceReadOnlyException {
314        checkReadWrite();
315        _value.setFromTime(fromTime);
316    }
317    
318    public boolean getFromTimeHasBeenModified() {
319        return _value.getFromTimeHasBeenModified();
320    }
321    
322    public Long getThruTime() {
323        return _value.getThruTime();
324    }
325    
326    public void setThruTime(Long thruTime)
327            throws PersistenceNotNullException, PersistenceReadOnlyException {
328        checkReadWrite();
329        _value.setThruTime(thruTime);
330    }
331    
332    public boolean getThruTimeHasBeenModified() {
333        return _value.getThruTimeHasBeenModified();
334    }
335    
336}