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