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 * PaymentCheck.java
021 */
022
023package com.echothree.model.data.payment.server.entity;
024
025import com.echothree.model.data.payment.common.pk.PaymentCheckPK;
026
027import com.echothree.model.data.payment.common.pk.PaymentPK;
028
029import com.echothree.model.data.payment.server.entity.Payment;
030
031import com.echothree.model.data.payment.server.factory.PaymentFactory;
032
033import com.echothree.model.data.payment.common.pk.PaymentCheckPK;
034
035import com.echothree.model.data.payment.server.value.PaymentCheckValue;
036
037import com.echothree.model.data.payment.server.factory.PaymentCheckFactory;
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 PaymentCheck
056        extends BaseEntity
057        implements Serializable {
058    
059    private PaymentCheckPK _pk;
060    private PaymentCheckValue _value;
061    
062    /** Creates a new instance of PaymentCheck */
063    public PaymentCheck()
064            throws PersistenceException {
065        super();
066    }
067    
068    /** Creates a new instance of PaymentCheck */
069    public PaymentCheck(PaymentCheckValue value, EntityPermission entityPermission) {
070        super(entityPermission);
071        
072        _value = value;
073        _pk = value.getPrimaryKey();
074    }
075    
076    @Override
077    public PaymentCheckFactory getBaseFactoryInstance() {
078        return PaymentCheckFactory.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 PaymentCheck that) {
102            PaymentCheckValue thatValue = that.getPaymentCheckValue();
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 PaymentCheckValue getPaymentCheckValue() {
122        return _value;
123    }
124    
125    public void setPaymentCheckValue(PaymentCheckValue value)
126            throws PersistenceReadOnlyException {
127        checkReadWrite();
128        _value = value;
129    }
130    
131    @Override
132    public PaymentCheckPK getPrimaryKey() {
133        return _pk;
134    }
135    
136    public PaymentPK getPaymentPK() {
137        return _value.getPaymentPK();
138    }
139    
140    public Payment getPayment(EntityPermission entityPermission) {
141        PaymentPK pk = getPaymentPK();
142        Payment entity = pk == null? null: PaymentFactory.getInstance().getEntityFromPK(entityPermission, pk);
143        
144        return entity;
145    }
146    
147    public Payment getPayment() {
148        return getPayment(EntityPermission.READ_ONLY);
149    }
150    
151    public Payment getPaymentForUpdate() {
152        return getPayment(EntityPermission.READ_WRITE);
153    }
154    
155    public void setPaymentPK(PaymentPK paymentPK)
156            throws PersistenceNotNullException, PersistenceReadOnlyException {
157        checkReadWrite();
158        _value.setPaymentPK(paymentPK);
159    }
160    
161    public void setPayment(Payment entity) {
162        setPaymentPK(entity == null? null: entity.getPrimaryKey());
163    }
164    
165    public boolean getPaymentPKHasBeenModified() {
166        return _value.getPaymentPKHasBeenModified();
167    }
168    
169    public String getReference() {
170        return _value.getReference();
171    }
172    
173    public void setReference(String reference)
174            throws PersistenceNotNullException, PersistenceReadOnlyException {
175        checkReadWrite();
176        _value.setReference(reference);
177    }
178    
179    public boolean getReferenceHasBeenModified() {
180        return _value.getReferenceHasBeenModified();
181    }
182    
183    public Long getFromTime() {
184        return _value.getFromTime();
185    }
186    
187    public void setFromTime(Long fromTime)
188            throws PersistenceNotNullException, PersistenceReadOnlyException {
189        checkReadWrite();
190        _value.setFromTime(fromTime);
191    }
192    
193    public boolean getFromTimeHasBeenModified() {
194        return _value.getFromTimeHasBeenModified();
195    }
196    
197    public Long getThruTime() {
198        return _value.getThruTime();
199    }
200    
201    public void setThruTime(Long thruTime)
202            throws PersistenceNotNullException, PersistenceReadOnlyException {
203        checkReadWrite();
204        _value.setThruTime(thruTime);
205    }
206    
207    public boolean getThruTimeHasBeenModified() {
208        return _value.getThruTimeHasBeenModified();
209    }
210    
211}