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 * 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
058public class CurrencyDescription
059        extends BaseEntity
060        implements Serializable {
061    
062    private CurrencyDescriptionPK _pk;
063    private CurrencyDescriptionValue _value;
064    
065    /** Creates a new instance of CurrencyDescription */
066    public CurrencyDescription()
067            throws PersistenceException {
068        super();
069    }
070    
071    /** Creates a new instance of CurrencyDescription */
072    public CurrencyDescription(CurrencyDescriptionValue value, EntityPermission entityPermission) {
073        super(entityPermission);
074        
075        _value = value;
076        _pk = value.getPrimaryKey();
077    }
078    
079    @Override
080    public CurrencyDescriptionFactory getBaseFactoryInstance() {
081        return CurrencyDescriptionFactory.getInstance();
082    }
083    
084    @Override
085    public boolean hasBeenModified() {
086        return _value.hasBeenModified();
087    }
088    
089    @Override
090    public int hashCode() {
091        return _pk.hashCode();
092    }
093    
094    @Override
095    public String toString() {
096        return _pk.toString();
097    }
098    
099    @Override
100    public boolean equals(Object other) {
101        if(this == other)
102            return true;
103        
104        if(other instanceof CurrencyDescription) {
105            CurrencyDescription that = (CurrencyDescription)other;
106            
107            CurrencyDescriptionValue thatValue = that.getCurrencyDescriptionValue();
108            return _value.equals(thatValue);
109        } else {
110            return false;
111        }
112    }
113    
114    @Override
115    public void store(Session session)
116            throws PersistenceDatabaseException {
117        getBaseFactoryInstance().store(session, this);
118    }
119    
120    @Override
121    public void remove(Session session)
122            throws PersistenceDatabaseException {
123        getBaseFactoryInstance().remove(session, this);
124    }
125    
126    @Override
127    public void remove()
128            throws PersistenceDatabaseException {
129        getBaseFactoryInstance().remove(ThreadSession.currentSession(), this);
130    }
131    
132    public CurrencyDescriptionValue getCurrencyDescriptionValue() {
133        return _value;
134    }
135    
136    public void setCurrencyDescriptionValue(CurrencyDescriptionValue value)
137            throws PersistenceReadOnlyException {
138        checkReadWrite();
139        _value = value;
140    }
141    
142    @Override
143    public CurrencyDescriptionPK getPrimaryKey() {
144        return _pk;
145    }
146    
147    public CurrencyPK getCurrencyPK() {
148        return _value.getCurrencyPK();
149    }
150    
151    public Currency getCurrency(Session session, EntityPermission entityPermission) {
152        return CurrencyFactory.getInstance().getEntityFromPK(session, entityPermission, getCurrencyPK());
153    }
154    
155    public Currency getCurrency(EntityPermission entityPermission) {
156        return getCurrency(ThreadSession.currentSession(), entityPermission);
157    }
158    
159    public Currency getCurrency(Session session) {
160        return getCurrency(session, EntityPermission.READ_ONLY);
161    }
162    
163    public Currency getCurrency() {
164        return getCurrency(ThreadSession.currentSession(), EntityPermission.READ_ONLY);
165    }
166    
167    public Currency getCurrencyForUpdate(Session session) {
168        return getCurrency(session, EntityPermission.READ_WRITE);
169    }
170    
171    public Currency getCurrencyForUpdate() {
172        return getCurrency(ThreadSession.currentSession(), EntityPermission.READ_WRITE);
173    }
174    
175    public void setCurrencyPK(CurrencyPK currencyPK)
176            throws PersistenceNotNullException, PersistenceReadOnlyException {
177        checkReadWrite();
178        _value.setCurrencyPK(currencyPK);
179    }
180    
181    public void setCurrency(Currency entity) {
182        setCurrencyPK(entity == null? null: entity.getPrimaryKey());
183    }
184    
185    public boolean getCurrencyPKHasBeenModified() {
186        return _value.getCurrencyPKHasBeenModified();
187    }
188    
189    public LanguagePK getLanguagePK() {
190        return _value.getLanguagePK();
191    }
192    
193    public Language getLanguage(Session session, EntityPermission entityPermission) {
194        return LanguageFactory.getInstance().getEntityFromPK(session, entityPermission, getLanguagePK());
195    }
196    
197    public Language getLanguage(EntityPermission entityPermission) {
198        return getLanguage(ThreadSession.currentSession(), entityPermission);
199    }
200    
201    public Language getLanguage(Session session) {
202        return getLanguage(session, EntityPermission.READ_ONLY);
203    }
204    
205    public Language getLanguage() {
206        return getLanguage(ThreadSession.currentSession(), EntityPermission.READ_ONLY);
207    }
208    
209    public Language getLanguageForUpdate(Session session) {
210        return getLanguage(session, EntityPermission.READ_WRITE);
211    }
212    
213    public Language getLanguageForUpdate() {
214        return getLanguage(ThreadSession.currentSession(), EntityPermission.READ_WRITE);
215    }
216    
217    public void setLanguagePK(LanguagePK languagePK)
218            throws PersistenceNotNullException, PersistenceReadOnlyException {
219        checkReadWrite();
220        _value.setLanguagePK(languagePK);
221    }
222    
223    public void setLanguage(Language entity) {
224        setLanguagePK(entity == null? null: entity.getPrimaryKey());
225    }
226    
227    public boolean getLanguagePKHasBeenModified() {
228        return _value.getLanguagePKHasBeenModified();
229    }
230    
231    public String getDescription() {
232        return _value.getDescription();
233    }
234    
235    public void setDescription(String description)
236            throws PersistenceNotNullException, PersistenceReadOnlyException {
237        checkReadWrite();
238        _value.setDescription(description);
239    }
240    
241    public boolean getDescriptionHasBeenModified() {
242        return _value.getDescriptionHasBeenModified();
243    }
244    
245}