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 * PostalAddressLineElement.java
021 */
022
023package com.echothree.model.data.contact.server.entity;
024
025import com.echothree.model.data.contact.common.pk.PostalAddressLineElementPK;
026
027import com.echothree.model.data.contact.common.pk.PostalAddressLinePK;
028import com.echothree.model.data.contact.common.pk.PostalAddressElementTypePK;
029
030import com.echothree.model.data.contact.server.entity.PostalAddressLine;
031import com.echothree.model.data.contact.server.entity.PostalAddressElementType;
032
033import com.echothree.model.data.contact.server.factory.PostalAddressLineFactory;
034import com.echothree.model.data.contact.server.factory.PostalAddressElementTypeFactory;
035
036import com.echothree.model.data.contact.common.pk.PostalAddressLineElementPK;
037
038import com.echothree.model.data.contact.server.value.PostalAddressLineElementValue;
039
040import com.echothree.model.data.contact.server.factory.PostalAddressLineElementFactory;
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 PostalAddressLineElement
062        extends BaseEntity
063        implements Serializable {
064    
065    private PostalAddressLineElementPK _pk;
066    private PostalAddressLineElementValue _value;
067    
068    /** Creates a new instance of PostalAddressLineElement */
069    public PostalAddressLineElement()
070            throws PersistenceException {
071        super();
072    }
073    
074    /** Creates a new instance of PostalAddressLineElement */
075    public PostalAddressLineElement(PostalAddressLineElementValue value, EntityPermission entityPermission) {
076        super(entityPermission);
077        
078        _value = value;
079        _pk = value.getPrimaryKey();
080    }
081    
082    @Override
083    @Nonnull
084    public PostalAddressLineElementFactory getBaseFactoryInstance() {
085        return PostalAddressLineElementFactory.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 PostalAddressLineElement that) {
110            PostalAddressLineElementValue thatValue = that.getPostalAddressLineElementValue();
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 PostalAddressLineElementValue getPostalAddressLineElementValue() {
131        return _value;
132    }
133    
134    public void setPostalAddressLineElementValue(@Nonnull PostalAddressLineElementValue value)
135            throws PersistenceReadOnlyException {
136        checkReadWrite();
137        _value = value;
138    }
139    
140    @Override
141    @Nonnull
142    public PostalAddressLineElementPK getPrimaryKey() {
143        return _pk;
144    }
145    
146    @Nonnull
147    public PostalAddressLinePK getPostalAddressLinePK() {
148        return _value.getPostalAddressLinePK();
149    }
150    
151    @Nonnull
152    public PostalAddressLine getPostalAddressLine(EntityPermission entityPermission) {
153        return PostalAddressLineFactory.getInstance().getEntityFromPK(entityPermission, getPostalAddressLinePK());
154    }
155    
156    @Nonnull
157    public PostalAddressLine getPostalAddressLine() {
158        return getPostalAddressLine(EntityPermission.READ_ONLY);
159    }
160    
161    @Nonnull
162    public PostalAddressLine getPostalAddressLineForUpdate() {
163        return getPostalAddressLine(EntityPermission.READ_WRITE);
164    }
165    
166    public void setPostalAddressLinePK(@Nonnull PostalAddressLinePK postalAddressLinePK)
167            throws PersistenceNotNullException, PersistenceReadOnlyException {
168        checkReadWrite();
169        _value.setPostalAddressLinePK(postalAddressLinePK);
170    }
171    
172    public void setPostalAddressLine(@Nonnull PostalAddressLine entity) {
173        setPostalAddressLinePK(entity == null ? null : entity.getPrimaryKey());
174    }
175    
176    public boolean getPostalAddressLinePKHasBeenModified() {
177        return _value.getPostalAddressLinePKHasBeenModified();
178    }
179    
180    @Nonnull
181    public Integer getPostalAddressLineElementSortOrder() {
182        return _value.getPostalAddressLineElementSortOrder();
183    }
184    
185    public void setPostalAddressLineElementSortOrder(@Nonnull Integer postalAddressLineElementSortOrder)
186            throws PersistenceNotNullException, PersistenceReadOnlyException {
187        checkReadWrite();
188        _value.setPostalAddressLineElementSortOrder(postalAddressLineElementSortOrder);
189    }
190    
191    public boolean getPostalAddressLineElementSortOrderHasBeenModified() {
192        return _value.getPostalAddressLineElementSortOrderHasBeenModified();
193    }
194    
195    @Nonnull
196    public PostalAddressElementTypePK getPostalAddressElementTypePK() {
197        return _value.getPostalAddressElementTypePK();
198    }
199    
200    @Nonnull
201    public PostalAddressElementType getPostalAddressElementType(EntityPermission entityPermission) {
202        return PostalAddressElementTypeFactory.getInstance().getEntityFromPK(entityPermission, getPostalAddressElementTypePK());
203    }
204    
205    @Nonnull
206    public PostalAddressElementType getPostalAddressElementType() {
207        return getPostalAddressElementType(EntityPermission.READ_ONLY);
208    }
209    
210    @Nonnull
211    public PostalAddressElementType getPostalAddressElementTypeForUpdate() {
212        return getPostalAddressElementType(EntityPermission.READ_WRITE);
213    }
214    
215    public void setPostalAddressElementTypePK(@Nonnull PostalAddressElementTypePK postalAddressElementTypePK)
216            throws PersistenceNotNullException, PersistenceReadOnlyException {
217        checkReadWrite();
218        _value.setPostalAddressElementTypePK(postalAddressElementTypePK);
219    }
220    
221    public void setPostalAddressElementType(@Nonnull PostalAddressElementType entity) {
222        setPostalAddressElementTypePK(entity == null ? null : entity.getPrimaryKey());
223    }
224    
225    public boolean getPostalAddressElementTypePKHasBeenModified() {
226        return _value.getPostalAddressElementTypePKHasBeenModified();
227    }
228    
229    @Nullable
230    public String getPrefix() {
231        return _value.getPrefix();
232    }
233    
234    public void setPrefix(@Nullable String prefix)
235            throws PersistenceNotNullException, PersistenceReadOnlyException {
236        checkReadWrite();
237        _value.setPrefix(prefix);
238    }
239    
240    public boolean getPrefixHasBeenModified() {
241        return _value.getPrefixHasBeenModified();
242    }
243    
244    @Nonnull
245    public Boolean getAlwaysIncludePrefix() {
246        return _value.getAlwaysIncludePrefix();
247    }
248    
249    public void setAlwaysIncludePrefix(@Nonnull Boolean alwaysIncludePrefix)
250            throws PersistenceNotNullException, PersistenceReadOnlyException {
251        checkReadWrite();
252        _value.setAlwaysIncludePrefix(alwaysIncludePrefix);
253    }
254    
255    public boolean getAlwaysIncludePrefixHasBeenModified() {
256        return _value.getAlwaysIncludePrefixHasBeenModified();
257    }
258    
259    @Nullable
260    public String getSuffix() {
261        return _value.getSuffix();
262    }
263    
264    public void setSuffix(@Nullable String suffix)
265            throws PersistenceNotNullException, PersistenceReadOnlyException {
266        checkReadWrite();
267        _value.setSuffix(suffix);
268    }
269    
270    public boolean getSuffixHasBeenModified() {
271        return _value.getSuffixHasBeenModified();
272    }
273    
274    @Nonnull
275    public Boolean getAlwaysIncludeSuffix() {
276        return _value.getAlwaysIncludeSuffix();
277    }
278    
279    public void setAlwaysIncludeSuffix(@Nonnull Boolean alwaysIncludeSuffix)
280            throws PersistenceNotNullException, PersistenceReadOnlyException {
281        checkReadWrite();
282        _value.setAlwaysIncludeSuffix(alwaysIncludeSuffix);
283    }
284    
285    public boolean getAlwaysIncludeSuffixHasBeenModified() {
286        return _value.getAlwaysIncludeSuffixHasBeenModified();
287    }
288    
289    @Nonnull
290    public Long getFromTime() {
291        return _value.getFromTime();
292    }
293    
294    public void setFromTime(@Nonnull Long fromTime)
295            throws PersistenceNotNullException, PersistenceReadOnlyException {
296        checkReadWrite();
297        _value.setFromTime(fromTime);
298    }
299    
300    public boolean getFromTimeHasBeenModified() {
301        return _value.getFromTimeHasBeenModified();
302    }
303    
304    @Nonnull
305    public Long getThruTime() {
306        return _value.getThruTime();
307    }
308    
309    public void setThruTime(@Nonnull Long thruTime)
310            throws PersistenceNotNullException, PersistenceReadOnlyException {
311        checkReadWrite();
312        _value.setThruTime(thruTime);
313    }
314    
315    public boolean getThruTimeHasBeenModified() {
316        return _value.getThruTimeHasBeenModified();
317    }
318    
319}