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 * 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(Session session)
111            throws PersistenceDatabaseException {
112        getBaseFactoryInstance().store(session, this);
113    }
114    
115    @Override
116    public void remove(Session session)
117            throws PersistenceDatabaseException {
118        getBaseFactoryInstance().remove(session, this);
119    }
120    
121    @Override
122    public void remove()
123            throws PersistenceDatabaseException {
124        getBaseFactoryInstance().remove(ThreadSession.currentSession(), this);
125    }
126    
127    public PaymentCheckValue getPaymentCheckValue() {
128        return _value;
129    }
130    
131    public void setPaymentCheckValue(PaymentCheckValue value)
132            throws PersistenceReadOnlyException {
133        checkReadWrite();
134        _value = value;
135    }
136    
137    @Override
138    public PaymentCheckPK getPrimaryKey() {
139        return _pk;
140    }
141    
142    public PaymentPK getPaymentPK() {
143        return _value.getPaymentPK();
144    }
145    
146    public Payment getPayment(Session session, EntityPermission entityPermission) {
147        PaymentPK pk = getPaymentPK();
148        Payment entity = pk == null? null: PaymentFactory.getInstance().getEntityFromPK(session, entityPermission, pk);
149        
150        return entity;
151    }
152    
153    public Payment getPayment(EntityPermission entityPermission) {
154        return getPayment(ThreadSession.currentSession(), entityPermission);
155    }
156    
157    public Payment getPayment(Session session) {
158        return getPayment(session, EntityPermission.READ_ONLY);
159    }
160    
161    public Payment getPayment() {
162        return getPayment(ThreadSession.currentSession(), EntityPermission.READ_ONLY);
163    }
164    
165    public Payment getPaymentForUpdate(Session session) {
166        return getPayment(session, EntityPermission.READ_WRITE);
167    }
168    
169    public Payment getPaymentForUpdate() {
170        return getPayment(ThreadSession.currentSession(), EntityPermission.READ_WRITE);
171    }
172    
173    public void setPaymentPK(PaymentPK paymentPK)
174            throws PersistenceNotNullException, PersistenceReadOnlyException {
175        checkReadWrite();
176        _value.setPaymentPK(paymentPK);
177    }
178    
179    public void setPayment(Payment entity) {
180        setPaymentPK(entity == null? null: entity.getPrimaryKey());
181    }
182    
183    public boolean getPaymentPKHasBeenModified() {
184        return _value.getPaymentPKHasBeenModified();
185    }
186    
187    public String getReference() {
188        return _value.getReference();
189    }
190    
191    public void setReference(String reference)
192            throws PersistenceNotNullException, PersistenceReadOnlyException {
193        checkReadWrite();
194        _value.setReference(reference);
195    }
196    
197    public boolean getReferenceHasBeenModified() {
198        return _value.getReferenceHasBeenModified();
199    }
200    
201    public Long getFromTime() {
202        return _value.getFromTime();
203    }
204    
205    public void setFromTime(Long fromTime)
206            throws PersistenceNotNullException, PersistenceReadOnlyException {
207        checkReadWrite();
208        _value.setFromTime(fromTime);
209    }
210    
211    public boolean getFromTimeHasBeenModified() {
212        return _value.getFromTimeHasBeenModified();
213    }
214    
215    public Long getThruTime() {
216        return _value.getThruTime();
217    }
218    
219    public void setThruTime(Long thruTime)
220            throws PersistenceNotNullException, PersistenceReadOnlyException {
221        checkReadWrite();
222        _value.setThruTime(thruTime);
223    }
224    
225    public boolean getThruTimeHasBeenModified() {
226        return _value.getThruTimeHasBeenModified();
227    }
228    
229}