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
055import javax.annotation.Nonnull;
056import javax.annotation.Nullable;
057
058public class PaymentCheck
059        extends BaseEntity
060        implements Serializable {
061    
062    private PaymentCheckPK _pk;
063    private PaymentCheckValue _value;
064    
065    /** Creates a new instance of PaymentCheck */
066    public PaymentCheck()
067            throws PersistenceException {
068        super();
069    }
070    
071    /** Creates a new instance of PaymentCheck */
072    public PaymentCheck(PaymentCheckValue value, EntityPermission entityPermission) {
073        super(entityPermission);
074        
075        _value = value;
076        _pk = value.getPrimaryKey();
077    }
078    
079    @Override
080    @Nonnull
081    public PaymentCheckFactory getBaseFactoryInstance() {
082        return PaymentCheckFactory.getInstance();
083    }
084    
085    @Override
086    public boolean hasBeenModified() {
087        return _value.hasBeenModified();
088    }
089    
090    @Override
091    public int hashCode() {
092        return _pk.hashCode();
093    }
094    
095    @Override
096    @Nonnull
097    public String toString() {
098        return _pk.toString();
099    }
100    
101    @Override
102    public boolean equals(Object other) {
103        if(this == other)
104            return true;
105        
106        if(other instanceof PaymentCheck that) {
107            PaymentCheckValue thatValue = that.getPaymentCheckValue();
108            return _value.equals(thatValue);
109        } else {
110            return false;
111        }
112    }
113    
114    @Override
115    public void store()
116            throws PersistenceDatabaseException {
117        getBaseFactoryInstance().store(this);
118    }
119    
120    @Override
121    public void remove()
122            throws PersistenceDatabaseException {
123        getBaseFactoryInstance().remove(this);
124    }
125    
126    @Nonnull
127    public PaymentCheckValue getPaymentCheckValue() {
128        return _value;
129    }
130    
131    public void setPaymentCheckValue(@Nonnull PaymentCheckValue value)
132            throws PersistenceReadOnlyException {
133        checkReadWrite();
134        _value = value;
135    }
136    
137    @Override
138    @Nonnull
139    public PaymentCheckPK getPrimaryKey() {
140        return _pk;
141    }
142    
143    @Nullable
144    public PaymentPK getPaymentPK() {
145        return _value.getPaymentPK();
146    }
147    
148    @Nullable
149    public Payment getPayment(EntityPermission entityPermission) {
150        PaymentPK pk = getPaymentPK();
151        Payment entity = pk == null? null: PaymentFactory.getInstance().getEntityFromPK(entityPermission, pk);
152        
153        return entity;
154    }
155    
156    @Nullable
157    public Payment getPayment() {
158        return getPayment(EntityPermission.READ_ONLY);
159    }
160    
161    @Nullable
162    public Payment getPaymentForUpdate() {
163        return getPayment(EntityPermission.READ_WRITE);
164    }
165    
166    public void setPaymentPK(@Nullable PaymentPK paymentPK)
167            throws PersistenceNotNullException, PersistenceReadOnlyException {
168        checkReadWrite();
169        _value.setPaymentPK(paymentPK);
170    }
171    
172    public void setPayment(@Nullable Payment entity) {
173        setPaymentPK(entity == null ? null : entity.getPrimaryKey());
174    }
175    
176    public boolean getPaymentPKHasBeenModified() {
177        return _value.getPaymentPKHasBeenModified();
178    }
179    
180    @Nonnull
181    public String getReference() {
182        return _value.getReference();
183    }
184    
185    public void setReference(@Nonnull String reference)
186            throws PersistenceNotNullException, PersistenceReadOnlyException {
187        checkReadWrite();
188        _value.setReference(reference);
189    }
190    
191    public boolean getReferenceHasBeenModified() {
192        return _value.getReferenceHasBeenModified();
193    }
194    
195    @Nonnull
196    public Long getFromTime() {
197        return _value.getFromTime();
198    }
199    
200    public void setFromTime(@Nonnull Long fromTime)
201            throws PersistenceNotNullException, PersistenceReadOnlyException {
202        checkReadWrite();
203        _value.setFromTime(fromTime);
204    }
205    
206    public boolean getFromTimeHasBeenModified() {
207        return _value.getFromTimeHasBeenModified();
208    }
209    
210    @Nonnull
211    public Long getThruTime() {
212        return _value.getThruTime();
213    }
214    
215    public void setThruTime(@Nonnull Long thruTime)
216            throws PersistenceNotNullException, PersistenceReadOnlyException {
217        checkReadWrite();
218        _value.setThruTime(thruTime);
219    }
220    
221    public boolean getThruTimeHasBeenModified() {
222        return _value.getThruTimeHasBeenModified();
223    }
224    
225}