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