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 * EntityStringAttribute.java
021 */
022
023package com.echothree.model.data.core.server.entity;
024
025import com.echothree.model.data.core.common.pk.EntityStringAttributePK;
026
027import com.echothree.model.data.core.common.pk.EntityAttributePK;
028import com.echothree.model.data.core.common.pk.EntityInstancePK;
029import com.echothree.model.data.party.common.pk.LanguagePK;
030
031import com.echothree.model.data.core.server.entity.EntityAttribute;
032import com.echothree.model.data.core.server.entity.EntityInstance;
033import com.echothree.model.data.party.server.entity.Language;
034
035import com.echothree.model.data.core.server.factory.EntityAttributeFactory;
036import com.echothree.model.data.core.server.factory.EntityInstanceFactory;
037import com.echothree.model.data.party.server.factory.LanguageFactory;
038
039import com.echothree.model.data.core.common.pk.EntityStringAttributePK;
040
041import com.echothree.model.data.core.server.value.EntityStringAttributeValue;
042
043import com.echothree.model.data.core.server.factory.EntityStringAttributeFactory;
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
061import javax.annotation.Nonnull;
062import javax.annotation.Nullable;
063
064public class EntityStringAttribute
065        extends BaseEntity
066        implements Serializable {
067    
068    private EntityStringAttributePK _pk;
069    private EntityStringAttributeValue _value;
070    
071    /** Creates a new instance of EntityStringAttribute */
072    public EntityStringAttribute()
073            throws PersistenceException {
074        super();
075    }
076    
077    /** Creates a new instance of EntityStringAttribute */
078    public EntityStringAttribute(EntityStringAttributeValue value, EntityPermission entityPermission) {
079        super(entityPermission);
080        
081        _value = value;
082        _pk = value.getPrimaryKey();
083    }
084    
085    @Override
086    @Nonnull
087    public EntityStringAttributeFactory getBaseFactoryInstance() {
088        return EntityStringAttributeFactory.getInstance();
089    }
090    
091    @Override
092    public boolean hasBeenModified() {
093        return _value.hasBeenModified();
094    }
095    
096    @Override
097    public int hashCode() {
098        return _pk.hashCode();
099    }
100    
101    @Override
102    @Nonnull
103    public String toString() {
104        return _pk.toString();
105    }
106    
107    @Override
108    public boolean equals(Object other) {
109        if(this == other)
110            return true;
111        
112        if(other instanceof EntityStringAttribute that) {
113            EntityStringAttributeValue thatValue = that.getEntityStringAttributeValue();
114            return _value.equals(thatValue);
115        } else {
116            return false;
117        }
118    }
119    
120    @Override
121    public void store()
122            throws PersistenceDatabaseException {
123        getBaseFactoryInstance().store(this);
124    }
125    
126    @Override
127    public void remove()
128            throws PersistenceDatabaseException {
129        getBaseFactoryInstance().remove(this);
130    }
131    
132    @Nonnull
133    public EntityStringAttributeValue getEntityStringAttributeValue() {
134        return _value;
135    }
136    
137    public void setEntityStringAttributeValue(@Nonnull EntityStringAttributeValue value)
138            throws PersistenceReadOnlyException {
139        checkReadWrite();
140        _value = value;
141    }
142    
143    @Override
144    @Nonnull
145    public EntityStringAttributePK getPrimaryKey() {
146        return _pk;
147    }
148    
149    @Nonnull
150    public EntityAttributePK getEntityAttributePK() {
151        return _value.getEntityAttributePK();
152    }
153    
154    @Nonnull
155    public EntityAttribute getEntityAttribute(EntityPermission entityPermission) {
156        return EntityAttributeFactory.getInstance().getEntityFromPK(entityPermission, getEntityAttributePK());
157    }
158    
159    @Nonnull
160    public EntityAttribute getEntityAttribute() {
161        return getEntityAttribute(EntityPermission.READ_ONLY);
162    }
163    
164    @Nonnull
165    public EntityAttribute getEntityAttributeForUpdate() {
166        return getEntityAttribute(EntityPermission.READ_WRITE);
167    }
168    
169    public void setEntityAttributePK(@Nonnull EntityAttributePK entityAttributePK)
170            throws PersistenceNotNullException, PersistenceReadOnlyException {
171        checkReadWrite();
172        _value.setEntityAttributePK(entityAttributePK);
173    }
174    
175    public void setEntityAttribute(@Nonnull EntityAttribute entity) {
176        setEntityAttributePK(entity == null ? null : entity.getPrimaryKey());
177    }
178    
179    public boolean getEntityAttributePKHasBeenModified() {
180        return _value.getEntityAttributePKHasBeenModified();
181    }
182    
183    @Nonnull
184    public EntityInstancePK getEntityInstancePK() {
185        return _value.getEntityInstancePK();
186    }
187    
188    @Nonnull
189    public EntityInstance getEntityInstance(EntityPermission entityPermission) {
190        return EntityInstanceFactory.getInstance().getEntityFromPK(entityPermission, getEntityInstancePK());
191    }
192    
193    @Nonnull
194    public EntityInstance getEntityInstance() {
195        return getEntityInstance(EntityPermission.READ_ONLY);
196    }
197    
198    @Nonnull
199    public EntityInstance getEntityInstanceForUpdate() {
200        return getEntityInstance(EntityPermission.READ_WRITE);
201    }
202    
203    public void setEntityInstancePK(@Nonnull EntityInstancePK entityInstancePK)
204            throws PersistenceNotNullException, PersistenceReadOnlyException {
205        checkReadWrite();
206        _value.setEntityInstancePK(entityInstancePK);
207    }
208    
209    public void setEntityInstance(@Nonnull EntityInstance entity) {
210        setEntityInstancePK(entity == null ? null : entity.getPrimaryKey());
211    }
212    
213    public boolean getEntityInstancePKHasBeenModified() {
214        return _value.getEntityInstancePKHasBeenModified();
215    }
216    
217    @Nonnull
218    public LanguagePK getLanguagePK() {
219        return _value.getLanguagePK();
220    }
221    
222    @Nonnull
223    public Language getLanguage(EntityPermission entityPermission) {
224        return LanguageFactory.getInstance().getEntityFromPK(entityPermission, getLanguagePK());
225    }
226    
227    @Nonnull
228    public Language getLanguage() {
229        return getLanguage(EntityPermission.READ_ONLY);
230    }
231    
232    @Nonnull
233    public Language getLanguageForUpdate() {
234        return getLanguage(EntityPermission.READ_WRITE);
235    }
236    
237    public void setLanguagePK(@Nonnull LanguagePK languagePK)
238            throws PersistenceNotNullException, PersistenceReadOnlyException {
239        checkReadWrite();
240        _value.setLanguagePK(languagePK);
241    }
242    
243    public void setLanguage(@Nonnull Language entity) {
244        setLanguagePK(entity == null ? null : entity.getPrimaryKey());
245    }
246    
247    public boolean getLanguagePKHasBeenModified() {
248        return _value.getLanguagePKHasBeenModified();
249    }
250    
251    @Nonnull
252    public String getStringAttribute() {
253        return _value.getStringAttribute();
254    }
255    
256    public void setStringAttribute(@Nonnull String stringAttribute)
257            throws PersistenceNotNullException, PersistenceReadOnlyException {
258        checkReadWrite();
259        _value.setStringAttribute(stringAttribute);
260    }
261    
262    public boolean getStringAttributeHasBeenModified() {
263        return _value.getStringAttributeHasBeenModified();
264    }
265    
266    @Nonnull
267    public Long getFromTime() {
268        return _value.getFromTime();
269    }
270    
271    public void setFromTime(@Nonnull Long fromTime)
272            throws PersistenceNotNullException, PersistenceReadOnlyException {
273        checkReadWrite();
274        _value.setFromTime(fromTime);
275    }
276    
277    public boolean getFromTimeHasBeenModified() {
278        return _value.getFromTimeHasBeenModified();
279    }
280    
281    @Nonnull
282    public Long getThruTime() {
283        return _value.getThruTime();
284    }
285    
286    public void setThruTime(@Nonnull Long thruTime)
287            throws PersistenceNotNullException, PersistenceReadOnlyException {
288        checkReadWrite();
289        _value.setThruTime(thruTime);
290    }
291    
292    public boolean getThruTimeHasBeenModified() {
293        return _value.getThruTimeHasBeenModified();
294    }
295    
296}