001// --------------------------------------------------------------------------------
002// Copyright 2002-2025 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 * LocationNameElementDescription.java
021 */
022
023package com.echothree.model.data.warehouse.server.entity;
024
025import com.echothree.model.data.warehouse.common.pk.LocationNameElementDescriptionPK;
026
027import com.echothree.model.data.warehouse.common.pk.LocationNameElementPK;
028import com.echothree.model.data.party.common.pk.LanguagePK;
029
030import com.echothree.model.data.warehouse.server.entity.LocationNameElement;
031import com.echothree.model.data.party.server.entity.Language;
032
033import com.echothree.model.data.warehouse.server.factory.LocationNameElementFactory;
034import com.echothree.model.data.party.server.factory.LanguageFactory;
035
036import com.echothree.model.data.warehouse.common.pk.LocationNameElementDescriptionPK;
037
038import com.echothree.model.data.warehouse.server.value.LocationNameElementDescriptionValue;
039
040import com.echothree.model.data.warehouse.server.factory.LocationNameElementDescriptionFactory;
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 LocationNameElementDescription
059        extends BaseEntity
060        implements Serializable {
061    
062    private LocationNameElementDescriptionPK _pk;
063    private LocationNameElementDescriptionValue _value;
064    
065    /** Creates a new instance of LocationNameElementDescription */
066    public LocationNameElementDescription()
067            throws PersistenceException {
068        super();
069    }
070    
071    /** Creates a new instance of LocationNameElementDescription */
072    public LocationNameElementDescription(LocationNameElementDescriptionValue value, EntityPermission entityPermission) {
073        super(entityPermission);
074        
075        _value = value;
076        _pk = value.getPrimaryKey();
077    }
078    
079    @Override
080    public LocationNameElementDescriptionFactory getBaseFactoryInstance() {
081        return LocationNameElementDescriptionFactory.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 LocationNameElementDescription that) {
105            LocationNameElementDescriptionValue thatValue = that.getLocationNameElementDescriptionValue();
106            return _value.equals(thatValue);
107        } else {
108            return false;
109        }
110    }
111    
112    @Override
113    public void store(Session session)
114            throws PersistenceDatabaseException {
115        getBaseFactoryInstance().store(session, this);
116    }
117    
118    @Override
119    public void remove(Session session)
120            throws PersistenceDatabaseException {
121        getBaseFactoryInstance().remove(session, this);
122    }
123    
124    @Override
125    public void remove()
126            throws PersistenceDatabaseException {
127        getBaseFactoryInstance().remove(ThreadSession.currentSession(), this);
128    }
129    
130    public LocationNameElementDescriptionValue getLocationNameElementDescriptionValue() {
131        return _value;
132    }
133    
134    public void setLocationNameElementDescriptionValue(LocationNameElementDescriptionValue value)
135            throws PersistenceReadOnlyException {
136        checkReadWrite();
137        _value = value;
138    }
139    
140    @Override
141    public LocationNameElementDescriptionPK getPrimaryKey() {
142        return _pk;
143    }
144    
145    public LocationNameElementPK getLocationNameElementPK() {
146        return _value.getLocationNameElementPK();
147    }
148    
149    public LocationNameElement getLocationNameElement(Session session, EntityPermission entityPermission) {
150        return LocationNameElementFactory.getInstance().getEntityFromPK(session, entityPermission, getLocationNameElementPK());
151    }
152    
153    public LocationNameElement getLocationNameElement(EntityPermission entityPermission) {
154        return getLocationNameElement(ThreadSession.currentSession(), entityPermission);
155    }
156    
157    public LocationNameElement getLocationNameElement(Session session) {
158        return getLocationNameElement(session, EntityPermission.READ_ONLY);
159    }
160    
161    public LocationNameElement getLocationNameElement() {
162        return getLocationNameElement(ThreadSession.currentSession(), EntityPermission.READ_ONLY);
163    }
164    
165    public LocationNameElement getLocationNameElementForUpdate(Session session) {
166        return getLocationNameElement(session, EntityPermission.READ_WRITE);
167    }
168    
169    public LocationNameElement getLocationNameElementForUpdate() {
170        return getLocationNameElement(ThreadSession.currentSession(), EntityPermission.READ_WRITE);
171    }
172    
173    public void setLocationNameElementPK(LocationNameElementPK locationNameElementPK)
174            throws PersistenceNotNullException, PersistenceReadOnlyException {
175        checkReadWrite();
176        _value.setLocationNameElementPK(locationNameElementPK);
177    }
178    
179    public void setLocationNameElement(LocationNameElement entity) {
180        setLocationNameElementPK(entity == null? null: entity.getPrimaryKey());
181    }
182    
183    public boolean getLocationNameElementPKHasBeenModified() {
184        return _value.getLocationNameElementPKHasBeenModified();
185    }
186    
187    public LanguagePK getLanguagePK() {
188        return _value.getLanguagePK();
189    }
190    
191    public Language getLanguage(Session session, EntityPermission entityPermission) {
192        return LanguageFactory.getInstance().getEntityFromPK(session, entityPermission, getLanguagePK());
193    }
194    
195    public Language getLanguage(EntityPermission entityPermission) {
196        return getLanguage(ThreadSession.currentSession(), entityPermission);
197    }
198    
199    public Language getLanguage(Session session) {
200        return getLanguage(session, EntityPermission.READ_ONLY);
201    }
202    
203    public Language getLanguage() {
204        return getLanguage(ThreadSession.currentSession(), EntityPermission.READ_ONLY);
205    }
206    
207    public Language getLanguageForUpdate(Session session) {
208        return getLanguage(session, EntityPermission.READ_WRITE);
209    }
210    
211    public Language getLanguageForUpdate() {
212        return getLanguage(ThreadSession.currentSession(), EntityPermission.READ_WRITE);
213    }
214    
215    public void setLanguagePK(LanguagePK languagePK)
216            throws PersistenceNotNullException, PersistenceReadOnlyException {
217        checkReadWrite();
218        _value.setLanguagePK(languagePK);
219    }
220    
221    public void setLanguage(Language entity) {
222        setLanguagePK(entity == null? null: entity.getPrimaryKey());
223    }
224    
225    public boolean getLanguagePKHasBeenModified() {
226        return _value.getLanguagePKHasBeenModified();
227    }
228    
229    public String getDescription() {
230        return _value.getDescription();
231    }
232    
233    public void setDescription(String description)
234            throws PersistenceNotNullException, PersistenceReadOnlyException {
235        checkReadWrite();
236        _value.setDescription(description);
237    }
238    
239    public boolean getDescriptionHasBeenModified() {
240        return _value.getDescriptionHasBeenModified();
241    }
242    
243    public Long getFromTime() {
244        return _value.getFromTime();
245    }
246    
247    public void setFromTime(Long fromTime)
248            throws PersistenceNotNullException, PersistenceReadOnlyException {
249        checkReadWrite();
250        _value.setFromTime(fromTime);
251    }
252    
253    public boolean getFromTimeHasBeenModified() {
254        return _value.getFromTimeHasBeenModified();
255    }
256    
257    public Long getThruTime() {
258        return _value.getThruTime();
259    }
260    
261    public void setThruTime(Long thruTime)
262            throws PersistenceNotNullException, PersistenceReadOnlyException {
263        checkReadWrite();
264        _value.setThruTime(thruTime);
265    }
266    
267    public boolean getThruTimeHasBeenModified() {
268        return _value.getThruTimeHasBeenModified();
269    }
270    
271}