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 * CurrencyDescription.java
021 */
022
023package com.echothree.model.data.accounting.server.entity;
024
025import com.echothree.model.data.accounting.common.pk.CurrencyDescriptionPK;
026
027import com.echothree.model.data.accounting.common.pk.CurrencyPK;
028import com.echothree.model.data.party.common.pk.LanguagePK;
029
030import com.echothree.model.data.accounting.server.entity.Currency;
031import com.echothree.model.data.party.server.entity.Language;
032
033import com.echothree.model.data.accounting.server.factory.CurrencyFactory;
034import com.echothree.model.data.party.server.factory.LanguageFactory;
035
036import com.echothree.model.data.accounting.common.pk.CurrencyDescriptionPK;
037
038import com.echothree.model.data.accounting.server.value.CurrencyDescriptionValue;
039
040import com.echothree.model.data.accounting.server.factory.CurrencyDescriptionFactory;
041
042import com.echothree.util.common.exception.PersistenceException;
043import com.echothree.util.common.exception.PersistenceDatabaseException;
044import com.echothree.util.common.exception.PersistenceNotNullException;
045import com.echothree.util.common.exception.PersistenceReadOnlyException;
046
047import com.echothree.util.common.persistence.BasePK;
048
049import com.echothree.util.common.persistence.type.ByteArray;
050
051import com.echothree.util.server.persistence.BaseEntity;
052import com.echothree.util.server.persistence.EntityPermission;
053import com.echothree.util.server.persistence.Session;
054import com.echothree.util.server.persistence.ThreadSession;
055
056import java.io.Serializable;
057
058import javax.annotation.Nonnull;
059import javax.annotation.Nullable;
060
061public class CurrencyDescription
062        extends BaseEntity
063        implements Serializable {
064    
065    private CurrencyDescriptionPK _pk;
066    private CurrencyDescriptionValue _value;
067    
068    /** Creates a new instance of CurrencyDescription */
069    public CurrencyDescription()
070            throws PersistenceException {
071        super();
072    }
073    
074    /** Creates a new instance of CurrencyDescription */
075    public CurrencyDescription(CurrencyDescriptionValue value, EntityPermission entityPermission) {
076        super(entityPermission);
077        
078        _value = value;
079        _pk = value.getPrimaryKey();
080    }
081    
082    @Override
083    @Nonnull
084    public CurrencyDescriptionFactory getBaseFactoryInstance() {
085        return CurrencyDescriptionFactory.getInstance();
086    }
087    
088    @Override
089    public boolean hasBeenModified() {
090        return _value.hasBeenModified();
091    }
092    
093    @Override
094    public int hashCode() {
095        return _pk.hashCode();
096    }
097    
098    @Override
099    @Nonnull
100    public String toString() {
101        return _pk.toString();
102    }
103    
104    @Override
105    public boolean equals(Object other) {
106        if(this == other)
107            return true;
108        
109        if(other instanceof CurrencyDescription that) {
110            CurrencyDescriptionValue thatValue = that.getCurrencyDescriptionValue();
111            return _value.equals(thatValue);
112        } else {
113            return false;
114        }
115    }
116    
117    @Override
118    public void store()
119            throws PersistenceDatabaseException {
120        getBaseFactoryInstance().store(this);
121    }
122    
123    @Override
124    public void remove()
125            throws PersistenceDatabaseException {
126        getBaseFactoryInstance().remove(this);
127    }
128    
129    @Nonnull
130    public CurrencyDescriptionValue getCurrencyDescriptionValue() {
131        return _value;
132    }
133    
134    public void setCurrencyDescriptionValue(@Nonnull CurrencyDescriptionValue value)
135            throws PersistenceReadOnlyException {
136        checkReadWrite();
137        _value = value;
138    }
139    
140    @Override
141    @Nonnull
142    public CurrencyDescriptionPK getPrimaryKey() {
143        return _pk;
144    }
145    
146    @Nonnull
147    public CurrencyPK getCurrencyPK() {
148        return _value.getCurrencyPK();
149    }
150    
151    @Nonnull
152    public Currency getCurrency(EntityPermission entityPermission) {
153        return CurrencyFactory.getInstance().getEntityFromPK(entityPermission, getCurrencyPK());
154    }
155    
156    @Nonnull
157    public Currency getCurrency() {
158        return getCurrency(EntityPermission.READ_ONLY);
159    }
160    
161    @Nonnull
162    public Currency getCurrencyForUpdate() {
163        return getCurrency(EntityPermission.READ_WRITE);
164    }
165    
166    public void setCurrencyPK(@Nonnull CurrencyPK currencyPK)
167            throws PersistenceNotNullException, PersistenceReadOnlyException {
168        checkReadWrite();
169        _value.setCurrencyPK(currencyPK);
170    }
171    
172    public void setCurrency(@Nonnull Currency entity) {
173        setCurrencyPK(entity == null ? null : entity.getPrimaryKey());
174    }
175    
176    public boolean getCurrencyPKHasBeenModified() {
177        return _value.getCurrencyPKHasBeenModified();
178    }
179    
180    @Nonnull
181    public LanguagePK getLanguagePK() {
182        return _value.getLanguagePK();
183    }
184    
185    @Nonnull
186    public Language getLanguage(EntityPermission entityPermission) {
187        return LanguageFactory.getInstance().getEntityFromPK(entityPermission, getLanguagePK());
188    }
189    
190    @Nonnull
191    public Language getLanguage() {
192        return getLanguage(EntityPermission.READ_ONLY);
193    }
194    
195    @Nonnull
196    public Language getLanguageForUpdate() {
197        return getLanguage(EntityPermission.READ_WRITE);
198    }
199    
200    public void setLanguagePK(@Nonnull LanguagePK languagePK)
201            throws PersistenceNotNullException, PersistenceReadOnlyException {
202        checkReadWrite();
203        _value.setLanguagePK(languagePK);
204    }
205    
206    public void setLanguage(@Nonnull Language entity) {
207        setLanguagePK(entity == null ? null : entity.getPrimaryKey());
208    }
209    
210    public boolean getLanguagePKHasBeenModified() {
211        return _value.getLanguagePKHasBeenModified();
212    }
213    
214    @Nonnull
215    public String getDescription() {
216        return _value.getDescription();
217    }
218    
219    public void setDescription(@Nonnull String description)
220            throws PersistenceNotNullException, PersistenceReadOnlyException {
221        checkReadWrite();
222        _value.setDescription(description);
223    }
224    
225    public boolean getDescriptionHasBeenModified() {
226        return _value.getDescriptionHasBeenModified();
227    }
228    
229}