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