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 * GeoCodeDetail.java
021 */
022
023package com.echothree.model.data.geo.server.entity;
024
025import com.echothree.model.data.geo.common.pk.GeoCodeDetailPK;
026
027import com.echothree.model.data.geo.common.pk.GeoCodePK;
028import com.echothree.model.data.geo.common.pk.GeoCodeTypePK;
029import com.echothree.model.data.geo.common.pk.GeoCodeScopePK;
030
031import com.echothree.model.data.geo.server.entity.GeoCode;
032import com.echothree.model.data.geo.server.entity.GeoCodeType;
033import com.echothree.model.data.geo.server.entity.GeoCodeScope;
034
035import com.echothree.model.data.geo.server.factory.GeoCodeFactory;
036import com.echothree.model.data.geo.server.factory.GeoCodeTypeFactory;
037import com.echothree.model.data.geo.server.factory.GeoCodeScopeFactory;
038
039import com.echothree.model.data.geo.common.pk.GeoCodeDetailPK;
040
041import com.echothree.model.data.geo.server.value.GeoCodeDetailValue;
042
043import com.echothree.model.data.geo.server.factory.GeoCodeDetailFactory;
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
061public class GeoCodeDetail
062        extends BaseEntity
063        implements Serializable {
064    
065    private GeoCodeDetailPK _pk;
066    private GeoCodeDetailValue _value;
067    
068    /** Creates a new instance of GeoCodeDetail */
069    public GeoCodeDetail()
070            throws PersistenceException {
071        super();
072    }
073    
074    /** Creates a new instance of GeoCodeDetail */
075    public GeoCodeDetail(GeoCodeDetailValue value, EntityPermission entityPermission) {
076        super(entityPermission);
077        
078        _value = value;
079        _pk = value.getPrimaryKey();
080    }
081    
082    @Override
083    public GeoCodeDetailFactory getBaseFactoryInstance() {
084        return GeoCodeDetailFactory.getInstance();
085    }
086    
087    @Override
088    public boolean hasBeenModified() {
089        return _value.hasBeenModified();
090    }
091    
092    @Override
093    public int hashCode() {
094        return _pk.hashCode();
095    }
096    
097    @Override
098    public String toString() {
099        return _pk.toString();
100    }
101    
102    @Override
103    public boolean equals(Object other) {
104        if(this == other)
105            return true;
106        
107        if(other instanceof GeoCodeDetail) {
108            GeoCodeDetail that = (GeoCodeDetail)other;
109            
110            GeoCodeDetailValue thatValue = that.getGeoCodeDetailValue();
111            return _value.equals(thatValue);
112        } else {
113            return false;
114        }
115    }
116    
117    @Override
118    public void store(Session session)
119            throws PersistenceDatabaseException {
120        getBaseFactoryInstance().store(session, this);
121    }
122    
123    @Override
124    public void remove(Session session)
125            throws PersistenceDatabaseException {
126        getBaseFactoryInstance().remove(session, this);
127    }
128    
129    @Override
130    public void remove()
131            throws PersistenceDatabaseException {
132        getBaseFactoryInstance().remove(ThreadSession.currentSession(), this);
133    }
134    
135    public GeoCodeDetailValue getGeoCodeDetailValue() {
136        return _value;
137    }
138    
139    public void setGeoCodeDetailValue(GeoCodeDetailValue value)
140            throws PersistenceReadOnlyException {
141        checkReadWrite();
142        _value = value;
143    }
144    
145    @Override
146    public GeoCodeDetailPK getPrimaryKey() {
147        return _pk;
148    }
149    
150    public GeoCodePK getGeoCodePK() {
151        return _value.getGeoCodePK();
152    }
153    
154    public GeoCode getGeoCode(Session session, EntityPermission entityPermission) {
155        return GeoCodeFactory.getInstance().getEntityFromPK(session, entityPermission, getGeoCodePK());
156    }
157    
158    public GeoCode getGeoCode(EntityPermission entityPermission) {
159        return getGeoCode(ThreadSession.currentSession(), entityPermission);
160    }
161    
162    public GeoCode getGeoCode(Session session) {
163        return getGeoCode(session, EntityPermission.READ_ONLY);
164    }
165    
166    public GeoCode getGeoCode() {
167        return getGeoCode(ThreadSession.currentSession(), EntityPermission.READ_ONLY);
168    }
169    
170    public GeoCode getGeoCodeForUpdate(Session session) {
171        return getGeoCode(session, EntityPermission.READ_WRITE);
172    }
173    
174    public GeoCode getGeoCodeForUpdate() {
175        return getGeoCode(ThreadSession.currentSession(), EntityPermission.READ_WRITE);
176    }
177    
178    public void setGeoCodePK(GeoCodePK geoCodePK)
179            throws PersistenceNotNullException, PersistenceReadOnlyException {
180        checkReadWrite();
181        _value.setGeoCodePK(geoCodePK);
182    }
183    
184    public void setGeoCode(GeoCode entity) {
185        setGeoCodePK(entity == null? null: entity.getPrimaryKey());
186    }
187    
188    public boolean getGeoCodePKHasBeenModified() {
189        return _value.getGeoCodePKHasBeenModified();
190    }
191    
192    public String getGeoCodeName() {
193        return _value.getGeoCodeName();
194    }
195    
196    public void setGeoCodeName(String geoCodeName)
197            throws PersistenceNotNullException, PersistenceReadOnlyException {
198        checkReadWrite();
199        _value.setGeoCodeName(geoCodeName);
200    }
201    
202    public boolean getGeoCodeNameHasBeenModified() {
203        return _value.getGeoCodeNameHasBeenModified();
204    }
205    
206    public GeoCodeTypePK getGeoCodeTypePK() {
207        return _value.getGeoCodeTypePK();
208    }
209    
210    public GeoCodeType getGeoCodeType(Session session, EntityPermission entityPermission) {
211        return GeoCodeTypeFactory.getInstance().getEntityFromPK(session, entityPermission, getGeoCodeTypePK());
212    }
213    
214    public GeoCodeType getGeoCodeType(EntityPermission entityPermission) {
215        return getGeoCodeType(ThreadSession.currentSession(), entityPermission);
216    }
217    
218    public GeoCodeType getGeoCodeType(Session session) {
219        return getGeoCodeType(session, EntityPermission.READ_ONLY);
220    }
221    
222    public GeoCodeType getGeoCodeType() {
223        return getGeoCodeType(ThreadSession.currentSession(), EntityPermission.READ_ONLY);
224    }
225    
226    public GeoCodeType getGeoCodeTypeForUpdate(Session session) {
227        return getGeoCodeType(session, EntityPermission.READ_WRITE);
228    }
229    
230    public GeoCodeType getGeoCodeTypeForUpdate() {
231        return getGeoCodeType(ThreadSession.currentSession(), EntityPermission.READ_WRITE);
232    }
233    
234    public void setGeoCodeTypePK(GeoCodeTypePK geoCodeTypePK)
235            throws PersistenceNotNullException, PersistenceReadOnlyException {
236        checkReadWrite();
237        _value.setGeoCodeTypePK(geoCodeTypePK);
238    }
239    
240    public void setGeoCodeType(GeoCodeType entity) {
241        setGeoCodeTypePK(entity == null? null: entity.getPrimaryKey());
242    }
243    
244    public boolean getGeoCodeTypePKHasBeenModified() {
245        return _value.getGeoCodeTypePKHasBeenModified();
246    }
247    
248    public GeoCodeScopePK getGeoCodeScopePK() {
249        return _value.getGeoCodeScopePK();
250    }
251    
252    public GeoCodeScope getGeoCodeScope(Session session, EntityPermission entityPermission) {
253        return GeoCodeScopeFactory.getInstance().getEntityFromPK(session, entityPermission, getGeoCodeScopePK());
254    }
255    
256    public GeoCodeScope getGeoCodeScope(EntityPermission entityPermission) {
257        return getGeoCodeScope(ThreadSession.currentSession(), entityPermission);
258    }
259    
260    public GeoCodeScope getGeoCodeScope(Session session) {
261        return getGeoCodeScope(session, EntityPermission.READ_ONLY);
262    }
263    
264    public GeoCodeScope getGeoCodeScope() {
265        return getGeoCodeScope(ThreadSession.currentSession(), EntityPermission.READ_ONLY);
266    }
267    
268    public GeoCodeScope getGeoCodeScopeForUpdate(Session session) {
269        return getGeoCodeScope(session, EntityPermission.READ_WRITE);
270    }
271    
272    public GeoCodeScope getGeoCodeScopeForUpdate() {
273        return getGeoCodeScope(ThreadSession.currentSession(), EntityPermission.READ_WRITE);
274    }
275    
276    public void setGeoCodeScopePK(GeoCodeScopePK geoCodeScopePK)
277            throws PersistenceNotNullException, PersistenceReadOnlyException {
278        checkReadWrite();
279        _value.setGeoCodeScopePK(geoCodeScopePK);
280    }
281    
282    public void setGeoCodeScope(GeoCodeScope entity) {
283        setGeoCodeScopePK(entity == null? null: entity.getPrimaryKey());
284    }
285    
286    public boolean getGeoCodeScopePKHasBeenModified() {
287        return _value.getGeoCodeScopePKHasBeenModified();
288    }
289    
290    public Boolean getIsDefault() {
291        return _value.getIsDefault();
292    }
293    
294    public void setIsDefault(Boolean isDefault)
295            throws PersistenceNotNullException, PersistenceReadOnlyException {
296        checkReadWrite();
297        _value.setIsDefault(isDefault);
298    }
299    
300    public boolean getIsDefaultHasBeenModified() {
301        return _value.getIsDefaultHasBeenModified();
302    }
303    
304    public Integer getSortOrder() {
305        return _value.getSortOrder();
306    }
307    
308    public void setSortOrder(Integer sortOrder)
309            throws PersistenceNotNullException, PersistenceReadOnlyException {
310        checkReadWrite();
311        _value.setSortOrder(sortOrder);
312    }
313    
314    public boolean getSortOrderHasBeenModified() {
315        return _value.getSortOrderHasBeenModified();
316    }
317    
318    public Long getFromTime() {
319        return _value.getFromTime();
320    }
321    
322    public void setFromTime(Long fromTime)
323            throws PersistenceNotNullException, PersistenceReadOnlyException {
324        checkReadWrite();
325        _value.setFromTime(fromTime);
326    }
327    
328    public boolean getFromTimeHasBeenModified() {
329        return _value.getFromTimeHasBeenModified();
330    }
331    
332    public Long getThruTime() {
333        return _value.getThruTime();
334    }
335    
336    public void setThruTime(Long thruTime)
337            throws PersistenceNotNullException, PersistenceReadOnlyException {
338        checkReadWrite();
339        _value.setThruTime(thruTime);
340    }
341    
342    public boolean getThruTimeHasBeenModified() {
343        return _value.getThruTimeHasBeenModified();
344    }
345    
346}