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 * TaxDetail.java
021 */
022
023package com.echothree.model.data.tax.server.entity;
024
025import com.echothree.model.data.tax.common.pk.TaxDetailPK;
026
027import com.echothree.model.data.tax.common.pk.TaxPK;
028import com.echothree.model.data.contact.common.pk.ContactMechanismPurposePK;
029import com.echothree.model.data.accounting.common.pk.GlAccountPK;
030
031import com.echothree.model.data.tax.server.entity.Tax;
032import com.echothree.model.data.contact.server.entity.ContactMechanismPurpose;
033import com.echothree.model.data.accounting.server.entity.GlAccount;
034
035import com.echothree.model.data.tax.server.factory.TaxFactory;
036import com.echothree.model.data.contact.server.factory.ContactMechanismPurposeFactory;
037import com.echothree.model.data.accounting.server.factory.GlAccountFactory;
038
039import com.echothree.model.data.tax.common.pk.TaxDetailPK;
040
041import com.echothree.model.data.tax.server.value.TaxDetailValue;
042
043import com.echothree.model.data.tax.server.factory.TaxDetailFactory;
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 TaxDetail
062        extends BaseEntity
063        implements Serializable {
064    
065    private TaxDetailPK _pk;
066    private TaxDetailValue _value;
067    
068    /** Creates a new instance of TaxDetail */
069    public TaxDetail()
070            throws PersistenceException {
071        super();
072    }
073    
074    /** Creates a new instance of TaxDetail */
075    public TaxDetail(TaxDetailValue value, EntityPermission entityPermission) {
076        super(entityPermission);
077        
078        _value = value;
079        _pk = value.getPrimaryKey();
080    }
081    
082    @Override
083    public TaxDetailFactory getBaseFactoryInstance() {
084        return TaxDetailFactory.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 TaxDetail) {
108            TaxDetail that = (TaxDetail)other;
109            
110            TaxDetailValue thatValue = that.getTaxDetailValue();
111            return _value.equals(thatValue);
112        } else {
113            return false;
114        }
115    }
116    
117    @Override
118    public void store(Session session)
119            throws PersistenceDatabaseException {
120        getBaseFactoryInstance().store(session, this);
121    }
122    
123    @Override
124    public void remove(Session session)
125            throws PersistenceDatabaseException {
126        getBaseFactoryInstance().remove(session, this);
127    }
128    
129    @Override
130    public void remove()
131            throws PersistenceDatabaseException {
132        getBaseFactoryInstance().remove(ThreadSession.currentSession(), this);
133    }
134    
135    public TaxDetailValue getTaxDetailValue() {
136        return _value;
137    }
138    
139    public void setTaxDetailValue(TaxDetailValue value)
140            throws PersistenceReadOnlyException {
141        checkReadWrite();
142        _value = value;
143    }
144    
145    @Override
146    public TaxDetailPK getPrimaryKey() {
147        return _pk;
148    }
149    
150    public TaxPK getTaxPK() {
151        return _value.getTaxPK();
152    }
153    
154    public Tax getTax(Session session, EntityPermission entityPermission) {
155        return TaxFactory.getInstance().getEntityFromPK(session, entityPermission, getTaxPK());
156    }
157    
158    public Tax getTax(EntityPermission entityPermission) {
159        return getTax(ThreadSession.currentSession(), entityPermission);
160    }
161    
162    public Tax getTax(Session session) {
163        return getTax(session, EntityPermission.READ_ONLY);
164    }
165    
166    public Tax getTax() {
167        return getTax(ThreadSession.currentSession(), EntityPermission.READ_ONLY);
168    }
169    
170    public Tax getTaxForUpdate(Session session) {
171        return getTax(session, EntityPermission.READ_WRITE);
172    }
173    
174    public Tax getTaxForUpdate() {
175        return getTax(ThreadSession.currentSession(), EntityPermission.READ_WRITE);
176    }
177    
178    public void setTaxPK(TaxPK taxPK)
179            throws PersistenceNotNullException, PersistenceReadOnlyException {
180        checkReadWrite();
181        _value.setTaxPK(taxPK);
182    }
183    
184    public void setTax(Tax entity) {
185        setTaxPK(entity == null? null: entity.getPrimaryKey());
186    }
187    
188    public boolean getTaxPKHasBeenModified() {
189        return _value.getTaxPKHasBeenModified();
190    }
191    
192    public String getTaxName() {
193        return _value.getTaxName();
194    }
195    
196    public void setTaxName(String taxName)
197            throws PersistenceNotNullException, PersistenceReadOnlyException {
198        checkReadWrite();
199        _value.setTaxName(taxName);
200    }
201    
202    public boolean getTaxNameHasBeenModified() {
203        return _value.getTaxNameHasBeenModified();
204    }
205    
206    public ContactMechanismPurposePK getContactMechanismPurposePK() {
207        return _value.getContactMechanismPurposePK();
208    }
209    
210    public ContactMechanismPurpose getContactMechanismPurpose(Session session, EntityPermission entityPermission) {
211        return ContactMechanismPurposeFactory.getInstance().getEntityFromPK(session, entityPermission, getContactMechanismPurposePK());
212    }
213    
214    public ContactMechanismPurpose getContactMechanismPurpose(EntityPermission entityPermission) {
215        return getContactMechanismPurpose(ThreadSession.currentSession(), entityPermission);
216    }
217    
218    public ContactMechanismPurpose getContactMechanismPurpose(Session session) {
219        return getContactMechanismPurpose(session, EntityPermission.READ_ONLY);
220    }
221    
222    public ContactMechanismPurpose getContactMechanismPurpose() {
223        return getContactMechanismPurpose(ThreadSession.currentSession(), EntityPermission.READ_ONLY);
224    }
225    
226    public ContactMechanismPurpose getContactMechanismPurposeForUpdate(Session session) {
227        return getContactMechanismPurpose(session, EntityPermission.READ_WRITE);
228    }
229    
230    public ContactMechanismPurpose getContactMechanismPurposeForUpdate() {
231        return getContactMechanismPurpose(ThreadSession.currentSession(), EntityPermission.READ_WRITE);
232    }
233    
234    public void setContactMechanismPurposePK(ContactMechanismPurposePK contactMechanismPurposePK)
235            throws PersistenceNotNullException, PersistenceReadOnlyException {
236        checkReadWrite();
237        _value.setContactMechanismPurposePK(contactMechanismPurposePK);
238    }
239    
240    public void setContactMechanismPurpose(ContactMechanismPurpose entity) {
241        setContactMechanismPurposePK(entity == null? null: entity.getPrimaryKey());
242    }
243    
244    public boolean getContactMechanismPurposePKHasBeenModified() {
245        return _value.getContactMechanismPurposePKHasBeenModified();
246    }
247    
248    public GlAccountPK getGlAccountPK() {
249        return _value.getGlAccountPK();
250    }
251    
252    public GlAccount getGlAccount(Session session, EntityPermission entityPermission) {
253        return GlAccountFactory.getInstance().getEntityFromPK(session, entityPermission, getGlAccountPK());
254    }
255    
256    public GlAccount getGlAccount(EntityPermission entityPermission) {
257        return getGlAccount(ThreadSession.currentSession(), entityPermission);
258    }
259    
260    public GlAccount getGlAccount(Session session) {
261        return getGlAccount(session, EntityPermission.READ_ONLY);
262    }
263    
264    public GlAccount getGlAccount() {
265        return getGlAccount(ThreadSession.currentSession(), EntityPermission.READ_ONLY);
266    }
267    
268    public GlAccount getGlAccountForUpdate(Session session) {
269        return getGlAccount(session, EntityPermission.READ_WRITE);
270    }
271    
272    public GlAccount getGlAccountForUpdate() {
273        return getGlAccount(ThreadSession.currentSession(), EntityPermission.READ_WRITE);
274    }
275    
276    public void setGlAccountPK(GlAccountPK glAccountPK)
277            throws PersistenceNotNullException, PersistenceReadOnlyException {
278        checkReadWrite();
279        _value.setGlAccountPK(glAccountPK);
280    }
281    
282    public void setGlAccount(GlAccount entity) {
283        setGlAccountPK(entity == null? null: entity.getPrimaryKey());
284    }
285    
286    public boolean getGlAccountPKHasBeenModified() {
287        return _value.getGlAccountPKHasBeenModified();
288    }
289    
290    public Boolean getIncludeShippingCharge() {
291        return _value.getIncludeShippingCharge();
292    }
293    
294    public void setIncludeShippingCharge(Boolean includeShippingCharge)
295            throws PersistenceNotNullException, PersistenceReadOnlyException {
296        checkReadWrite();
297        _value.setIncludeShippingCharge(includeShippingCharge);
298    }
299    
300    public boolean getIncludeShippingChargeHasBeenModified() {
301        return _value.getIncludeShippingChargeHasBeenModified();
302    }
303    
304    public Boolean getIncludeProcessingCharge() {
305        return _value.getIncludeProcessingCharge();
306    }
307    
308    public void setIncludeProcessingCharge(Boolean includeProcessingCharge)
309            throws PersistenceNotNullException, PersistenceReadOnlyException {
310        checkReadWrite();
311        _value.setIncludeProcessingCharge(includeProcessingCharge);
312    }
313    
314    public boolean getIncludeProcessingChargeHasBeenModified() {
315        return _value.getIncludeProcessingChargeHasBeenModified();
316    }
317    
318    public Boolean getIncludeInsuranceCharge() {
319        return _value.getIncludeInsuranceCharge();
320    }
321    
322    public void setIncludeInsuranceCharge(Boolean includeInsuranceCharge)
323            throws PersistenceNotNullException, PersistenceReadOnlyException {
324        checkReadWrite();
325        _value.setIncludeInsuranceCharge(includeInsuranceCharge);
326    }
327    
328    public boolean getIncludeInsuranceChargeHasBeenModified() {
329        return _value.getIncludeInsuranceChargeHasBeenModified();
330    }
331    
332    public Integer getPercent() {
333        return _value.getPercent();
334    }
335    
336    public void setPercent(Integer percent)
337            throws PersistenceNotNullException, PersistenceReadOnlyException {
338        checkReadWrite();
339        _value.setPercent(percent);
340    }
341    
342    public boolean getPercentHasBeenModified() {
343        return _value.getPercentHasBeenModified();
344    }
345    
346    public Boolean getIsDefault() {
347        return _value.getIsDefault();
348    }
349    
350    public void setIsDefault(Boolean isDefault)
351            throws PersistenceNotNullException, PersistenceReadOnlyException {
352        checkReadWrite();
353        _value.setIsDefault(isDefault);
354    }
355    
356    public boolean getIsDefaultHasBeenModified() {
357        return _value.getIsDefaultHasBeenModified();
358    }
359    
360    public Integer getSortOrder() {
361        return _value.getSortOrder();
362    }
363    
364    public void setSortOrder(Integer sortOrder)
365            throws PersistenceNotNullException, PersistenceReadOnlyException {
366        checkReadWrite();
367        _value.setSortOrder(sortOrder);
368    }
369    
370    public boolean getSortOrderHasBeenModified() {
371        return _value.getSortOrderHasBeenModified();
372    }
373    
374    public Long getFromTime() {
375        return _value.getFromTime();
376    }
377    
378    public void setFromTime(Long fromTime)
379            throws PersistenceNotNullException, PersistenceReadOnlyException {
380        checkReadWrite();
381        _value.setFromTime(fromTime);
382    }
383    
384    public boolean getFromTimeHasBeenModified() {
385        return _value.getFromTimeHasBeenModified();
386    }
387    
388    public Long getThruTime() {
389        return _value.getThruTime();
390    }
391    
392    public void setThruTime(Long thruTime)
393            throws PersistenceNotNullException, PersistenceReadOnlyException {
394        checkReadWrite();
395        _value.setThruTime(thruTime);
396    }
397    
398    public boolean getThruTimeHasBeenModified() {
399        return _value.getThruTimeHasBeenModified();
400    }
401    
402}