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 * ContentPageLayoutAreaValue.java
021 */
022
023package com.echothree.model.data.content.server.value;
024
025import com.echothree.model.data.content.common.pk.ContentPageLayoutAreaPK;
026
027import com.echothree.model.data.content.server.factory.ContentPageLayoutAreaFactory;
028
029import com.echothree.model.data.content.common.pk.ContentPageLayoutPK;
030import com.echothree.model.data.content.common.pk.ContentPageAreaTypePK;
031
032import com.echothree.util.common.exception.PersistenceCloneException;
033import com.echothree.util.common.exception.PersistenceNotNullException;
034
035import com.echothree.util.server.persistence.BaseValue;
036
037import java.io.Serializable;
038
039public class ContentPageLayoutAreaValue
040        extends BaseValue<ContentPageLayoutAreaPK>
041        implements Cloneable, Serializable {
042    
043    private ContentPageLayoutPK contentPageLayoutPK;
044    private boolean contentPageLayoutPKHasBeenModified = false;
045    private ContentPageAreaTypePK contentPageAreaTypePK;
046    private boolean contentPageAreaTypePKHasBeenModified = false;
047    private Boolean showDescriptionField;
048    private boolean showDescriptionFieldHasBeenModified = false;
049    private Integer sortOrder;
050    private boolean sortOrderHasBeenModified = false;
051    
052    private transient Integer _hashCode = null;
053    private transient String _stringValue = null;
054    
055    private void constructFields(ContentPageLayoutPK contentPageLayoutPK, ContentPageAreaTypePK contentPageAreaTypePK, Boolean showDescriptionField, Integer sortOrder)
056            throws PersistenceNotNullException {
057        checkForNull(contentPageLayoutPK);
058        this.contentPageLayoutPK = contentPageLayoutPK;
059        checkForNull(contentPageAreaTypePK);
060        this.contentPageAreaTypePK = contentPageAreaTypePK;
061        checkForNull(showDescriptionField);
062        this.showDescriptionField = showDescriptionField;
063        checkForNull(sortOrder);
064        this.sortOrder = sortOrder;
065    }
066    
067    /** Creates a new instance of ContentPageLayoutAreaValue */
068    public ContentPageLayoutAreaValue(ContentPageLayoutAreaPK contentPageLayoutAreaPK, ContentPageLayoutPK contentPageLayoutPK, ContentPageAreaTypePK contentPageAreaTypePK, Boolean showDescriptionField, Integer sortOrder)
069            throws PersistenceNotNullException {
070        super(contentPageLayoutAreaPK);
071        constructFields(contentPageLayoutPK, contentPageAreaTypePK, showDescriptionField, sortOrder);
072    }
073    
074    /** Creates a new instance of ContentPageLayoutAreaValue */
075    public ContentPageLayoutAreaValue(ContentPageLayoutPK contentPageLayoutPK, ContentPageAreaTypePK contentPageAreaTypePK, Boolean showDescriptionField, Integer sortOrder)
076            throws PersistenceNotNullException {
077        super();
078        constructFields(contentPageLayoutPK, contentPageAreaTypePK, showDescriptionField, sortOrder);
079    }
080    
081   @Override
082   public ContentPageLayoutAreaFactory getBaseFactoryInstance() {
083        return ContentPageLayoutAreaFactory.getInstance();
084    }
085    
086    @Override
087    public ContentPageLayoutAreaValue clone() {
088        Object result;
089        
090        try {
091            result = super.clone();
092        } catch (CloneNotSupportedException cnse) {
093            // This shouldn't happen, fail when it does.
094            throw new PersistenceCloneException(cnse);
095        }
096        
097        return (ContentPageLayoutAreaValue)result;
098    }
099    
100   @Override
101    public ContentPageLayoutAreaPK getPrimaryKey() {
102        if(_primaryKey == null) {
103            _primaryKey = new ContentPageLayoutAreaPK(entityId);
104        }
105        
106        return _primaryKey;
107    }
108    
109    private void clearHashAndString() {
110        _hashCode = null;
111        _stringValue = null;
112    }
113    
114    @Override
115    public int hashCode() {
116        if(_hashCode == null) {
117            int hashCode = 17;
118            
119            hashCode = 37 * hashCode + ((entityId != null) ? entityId.hashCode() : 0);
120            
121            hashCode = 37 * hashCode + ((contentPageLayoutPK != null) ? contentPageLayoutPK.hashCode() : 0);
122            hashCode = 37 * hashCode + ((contentPageAreaTypePK != null) ? contentPageAreaTypePK.hashCode() : 0);
123            hashCode = 37 * hashCode + ((showDescriptionField != null) ? showDescriptionField.hashCode() : 0);
124            hashCode = 37 * hashCode + ((sortOrder != null) ? sortOrder.hashCode() : 0);
125            
126            _hashCode = hashCode;
127        }
128        
129        return _hashCode;
130    }
131    
132    @Override
133    public String toString() {
134        if(_stringValue == null) {
135            StringBuilder stringValue = new StringBuilder("{");
136            
137            stringValue.append("entityId=").append(getEntityId());
138            
139            stringValue.append(", contentPageLayoutPK=").append(getContentPageLayoutPK());
140            stringValue.append(", contentPageAreaTypePK=").append(getContentPageAreaTypePK());
141            stringValue.append(", showDescriptionField=").append(getShowDescriptionField());
142            stringValue.append(", sortOrder=").append(getSortOrder());
143            
144            stringValue.append('}');
145            
146            _stringValue = stringValue.toString();
147        }
148        return _stringValue;
149    }
150    
151    @Override
152    public boolean equals(Object other) {
153        if(this == other)
154            return true;
155        
156        if(!hasIdentity())
157            return false;
158        
159        if(other instanceof  ContentPageLayoutAreaValue) {
160            ContentPageLayoutAreaValue that = (ContentPageLayoutAreaValue)other;
161            
162            if(!that.hasIdentity())
163                return false;
164            
165            Long thisEntityId = getEntityId();
166            Long thatEntityId = that.getEntityId();
167            
168            boolean objectsEqual = thisEntityId.equals(thatEntityId);
169            if(objectsEqual)
170                objectsEqual = objectsEqual && isIdentical(that);
171            
172            return objectsEqual;
173        } else {
174            return false;
175        }
176    }
177    
178    public boolean isIdentical(Object other) {
179        if(other instanceof ContentPageLayoutAreaValue) {
180            ContentPageLayoutAreaValue that = (ContentPageLayoutAreaValue)other;
181            boolean objectsEqual = true;
182            
183            
184            if(objectsEqual) {
185                ContentPageLayoutPK thisContentPageLayoutPK = getContentPageLayoutPK();
186                ContentPageLayoutPK thatContentPageLayoutPK = that.getContentPageLayoutPK();
187                
188                if(thisContentPageLayoutPK == null) {
189                    objectsEqual = objectsEqual && (thatContentPageLayoutPK == null);
190                } else {
191                    objectsEqual = objectsEqual && thisContentPageLayoutPK.equals(thatContentPageLayoutPK);
192                }
193            }
194            
195            if(objectsEqual) {
196                ContentPageAreaTypePK thisContentPageAreaTypePK = getContentPageAreaTypePK();
197                ContentPageAreaTypePK thatContentPageAreaTypePK = that.getContentPageAreaTypePK();
198                
199                if(thisContentPageAreaTypePK == null) {
200                    objectsEqual = objectsEqual && (thatContentPageAreaTypePK == null);
201                } else {
202                    objectsEqual = objectsEqual && thisContentPageAreaTypePK.equals(thatContentPageAreaTypePK);
203                }
204            }
205            
206            if(objectsEqual) {
207                Boolean thisShowDescriptionField = getShowDescriptionField();
208                Boolean thatShowDescriptionField = that.getShowDescriptionField();
209                
210                if(thisShowDescriptionField == null) {
211                    objectsEqual = objectsEqual && (thatShowDescriptionField == null);
212                } else {
213                    objectsEqual = objectsEqual && thisShowDescriptionField.equals(thatShowDescriptionField);
214                }
215            }
216            
217            if(objectsEqual) {
218                Integer thisSortOrder = getSortOrder();
219                Integer thatSortOrder = that.getSortOrder();
220                
221                if(thisSortOrder == null) {
222                    objectsEqual = objectsEqual && (thatSortOrder == null);
223                } else {
224                    objectsEqual = objectsEqual && thisSortOrder.equals(thatSortOrder);
225                }
226            }
227            
228            return objectsEqual;
229        } else {
230            return false;
231        }
232    }
233    
234    @Override
235    public boolean hasBeenModified() {
236        return contentPageLayoutPKHasBeenModified || contentPageAreaTypePKHasBeenModified || showDescriptionFieldHasBeenModified || sortOrderHasBeenModified;
237    }
238    
239    @Override
240    public void clearHasBeenModified() {
241        contentPageLayoutPKHasBeenModified = false;
242        contentPageAreaTypePKHasBeenModified = false;
243        showDescriptionFieldHasBeenModified = false;
244        sortOrderHasBeenModified = false;
245    }
246    
247    public ContentPageLayoutPK getContentPageLayoutPK() {
248        return contentPageLayoutPK;
249    }
250    
251    public void setContentPageLayoutPK(ContentPageLayoutPK contentPageLayoutPK)
252            throws PersistenceNotNullException {
253        checkForNull(contentPageLayoutPK);
254        
255        boolean update = true;
256        
257        if(this.contentPageLayoutPK != null) {
258            if(this.contentPageLayoutPK.equals(contentPageLayoutPK)) {
259                update = false;
260            }
261        } else if(contentPageLayoutPK == null) {
262            update = false;
263        }
264        
265        if(update) {
266            this.contentPageLayoutPK = contentPageLayoutPK;
267            contentPageLayoutPKHasBeenModified = true;
268            clearHashAndString();
269        }
270    }
271    
272    public boolean getContentPageLayoutPKHasBeenModified() {
273        return contentPageLayoutPKHasBeenModified;
274    }
275    
276    public ContentPageAreaTypePK getContentPageAreaTypePK() {
277        return contentPageAreaTypePK;
278    }
279    
280    public void setContentPageAreaTypePK(ContentPageAreaTypePK contentPageAreaTypePK)
281            throws PersistenceNotNullException {
282        checkForNull(contentPageAreaTypePK);
283        
284        boolean update = true;
285        
286        if(this.contentPageAreaTypePK != null) {
287            if(this.contentPageAreaTypePK.equals(contentPageAreaTypePK)) {
288                update = false;
289            }
290        } else if(contentPageAreaTypePK == null) {
291            update = false;
292        }
293        
294        if(update) {
295            this.contentPageAreaTypePK = contentPageAreaTypePK;
296            contentPageAreaTypePKHasBeenModified = true;
297            clearHashAndString();
298        }
299    }
300    
301    public boolean getContentPageAreaTypePKHasBeenModified() {
302        return contentPageAreaTypePKHasBeenModified;
303    }
304    
305    public Boolean getShowDescriptionField() {
306        return showDescriptionField;
307    }
308    
309    public void setShowDescriptionField(Boolean showDescriptionField)
310            throws PersistenceNotNullException {
311        checkForNull(showDescriptionField);
312        
313        boolean update = true;
314        
315        if(this.showDescriptionField != null) {
316            if(this.showDescriptionField.equals(showDescriptionField)) {
317                update = false;
318            }
319        } else if(showDescriptionField == null) {
320            update = false;
321        }
322        
323        if(update) {
324            this.showDescriptionField = showDescriptionField;
325            showDescriptionFieldHasBeenModified = true;
326            clearHashAndString();
327        }
328    }
329    
330    public boolean getShowDescriptionFieldHasBeenModified() {
331        return showDescriptionFieldHasBeenModified;
332    }
333    
334    public Integer getSortOrder() {
335        return sortOrder;
336    }
337    
338    public void setSortOrder(Integer sortOrder)
339            throws PersistenceNotNullException {
340        checkForNull(sortOrder);
341        
342        boolean update = true;
343        
344        if(this.sortOrder != null) {
345            if(this.sortOrder.equals(sortOrder)) {
346                update = false;
347            }
348        } else if(sortOrder == null) {
349            update = false;
350        }
351        
352        if(update) {
353            this.sortOrder = sortOrder;
354            sortOrderHasBeenModified = true;
355            clearHashAndString();
356        }
357    }
358    
359    public boolean getSortOrderHasBeenModified() {
360        return sortOrderHasBeenModified;
361    }
362    
363}