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 * ItemVolumeValue.java
021 */
022
023package com.echothree.model.data.item.server.value;
024
025import com.echothree.model.data.item.common.pk.ItemVolumePK;
026
027import com.echothree.model.data.item.server.factory.ItemVolumeFactory;
028
029import com.echothree.model.data.item.common.pk.ItemPK;
030import com.echothree.model.data.uom.common.pk.UnitOfMeasureTypePK;
031import com.echothree.model.data.item.common.pk.ItemVolumeTypePK;
032
033import com.echothree.util.common.exception.PersistenceCloneException;
034import com.echothree.util.common.exception.PersistenceNotNullException;
035
036import com.echothree.util.server.persistence.BaseValue;
037
038import java.io.Serializable;
039
040public class ItemVolumeValue
041        extends BaseValue<ItemVolumePK>
042        implements Cloneable, Serializable {
043    
044    private ItemPK itemPK;
045    private boolean itemPKHasBeenModified = false;
046    private UnitOfMeasureTypePK unitOfMeasureTypePK;
047    private boolean unitOfMeasureTypePKHasBeenModified = false;
048    private ItemVolumeTypePK itemVolumeTypePK;
049    private boolean itemVolumeTypePKHasBeenModified = false;
050    private Long height;
051    private boolean heightHasBeenModified = false;
052    private Long width;
053    private boolean widthHasBeenModified = false;
054    private Long depth;
055    private boolean depthHasBeenModified = false;
056    private Long fromTime;
057    private boolean fromTimeHasBeenModified = false;
058    private Long thruTime;
059    private boolean thruTimeHasBeenModified = false;
060    
061    private transient Integer _hashCode = null;
062    private transient String _stringValue = null;
063    
064    private void constructFields(ItemPK itemPK, UnitOfMeasureTypePK unitOfMeasureTypePK, ItemVolumeTypePK itemVolumeTypePK, Long height, Long width, Long depth, Long fromTime, Long thruTime)
065            throws PersistenceNotNullException {
066        checkForNull(itemPK);
067        this.itemPK = itemPK;
068        checkForNull(unitOfMeasureTypePK);
069        this.unitOfMeasureTypePK = unitOfMeasureTypePK;
070        checkForNull(itemVolumeTypePK);
071        this.itemVolumeTypePK = itemVolumeTypePK;
072        checkForNull(height);
073        this.height = height;
074        checkForNull(width);
075        this.width = width;
076        checkForNull(depth);
077        this.depth = depth;
078        checkForNull(fromTime);
079        this.fromTime = fromTime;
080        checkForNull(thruTime);
081        this.thruTime = thruTime;
082    }
083    
084    /** Creates a new instance of ItemVolumeValue */
085    public ItemVolumeValue(ItemVolumePK itemVolumePK, ItemPK itemPK, UnitOfMeasureTypePK unitOfMeasureTypePK, ItemVolumeTypePK itemVolumeTypePK, Long height, Long width, Long depth, Long fromTime, Long thruTime)
086            throws PersistenceNotNullException {
087        super(itemVolumePK);
088        constructFields(itemPK, unitOfMeasureTypePK, itemVolumeTypePK, height, width, depth, fromTime, thruTime);
089    }
090    
091    /** Creates a new instance of ItemVolumeValue */
092    public ItemVolumeValue(ItemPK itemPK, UnitOfMeasureTypePK unitOfMeasureTypePK, ItemVolumeTypePK itemVolumeTypePK, Long height, Long width, Long depth, Long fromTime, Long thruTime)
093            throws PersistenceNotNullException {
094        super();
095        constructFields(itemPK, unitOfMeasureTypePK, itemVolumeTypePK, height, width, depth, fromTime, thruTime);
096    }
097    
098   @Override
099   public ItemVolumeFactory getBaseFactoryInstance() {
100        return ItemVolumeFactory.getInstance();
101    }
102    
103    @Override
104    public ItemVolumeValue clone() {
105        Object result;
106        
107        try {
108            result = super.clone();
109        } catch (CloneNotSupportedException cnse) {
110            // This shouldn't happen, fail when it does.
111            throw new PersistenceCloneException(cnse);
112        }
113        
114        return (ItemVolumeValue)result;
115    }
116    
117   @Override
118    public ItemVolumePK getPrimaryKey() {
119        if(_primaryKey == null) {
120            _primaryKey = new ItemVolumePK(entityId);
121        }
122        
123        return _primaryKey;
124    }
125    
126    private void clearHashAndString() {
127        _hashCode = null;
128        _stringValue = null;
129    }
130    
131    @Override
132    public int hashCode() {
133        if(_hashCode == null) {
134            int hashCode = 17;
135            
136            hashCode = 37 * hashCode + ((entityId != null) ? entityId.hashCode() : 0);
137            
138            hashCode = 37 * hashCode + ((itemPK != null) ? itemPK.hashCode() : 0);
139            hashCode = 37 * hashCode + ((unitOfMeasureTypePK != null) ? unitOfMeasureTypePK.hashCode() : 0);
140            hashCode = 37 * hashCode + ((itemVolumeTypePK != null) ? itemVolumeTypePK.hashCode() : 0);
141            hashCode = 37 * hashCode + ((height != null) ? height.hashCode() : 0);
142            hashCode = 37 * hashCode + ((width != null) ? width.hashCode() : 0);
143            hashCode = 37 * hashCode + ((depth != null) ? depth.hashCode() : 0);
144            hashCode = 37 * hashCode + ((fromTime != null) ? fromTime.hashCode() : 0);
145            hashCode = 37 * hashCode + ((thruTime != null) ? thruTime.hashCode() : 0);
146            
147            _hashCode = hashCode;
148        }
149        
150        return _hashCode;
151    }
152    
153    @Override
154    public String toString() {
155        if(_stringValue == null) {
156            _stringValue = "{" + 
157                    "entityId=" + getEntityId() +
158                    ", itemPK=" + getItemPK() +
159                    ", unitOfMeasureTypePK=" + getUnitOfMeasureTypePK() +
160                    ", itemVolumeTypePK=" + getItemVolumeTypePK() +
161                    ", height=" + getHeight() +
162                    ", width=" + getWidth() +
163                    ", depth=" + getDepth() +
164                    ", fromTime=" + getFromTime() +
165                    ", thruTime=" + getThruTime() +
166                    "}";
167        }
168        return _stringValue;
169    }
170    
171    @Override
172    public boolean equals(Object other) {
173        if(this == other)
174            return true;
175        
176        if(!hasIdentity())
177            return false;
178        
179        if(other instanceof  ItemVolumeValue that) {
180            if(!that.hasIdentity())
181                return false;
182            
183            Long thisEntityId = getEntityId();
184            Long thatEntityId = that.getEntityId();
185            
186            boolean objectsEqual = thisEntityId.equals(thatEntityId);
187            if(objectsEqual)
188                objectsEqual = isIdentical(that);
189            
190            return objectsEqual;
191        } else {
192            return false;
193        }
194    }
195    
196    public boolean isIdentical(Object other) {
197        if(other instanceof ItemVolumeValue that) {
198            boolean objectsEqual = true;
199            
200            
201            if(objectsEqual) {
202                ItemPK thisItemPK = getItemPK();
203                ItemPK thatItemPK = that.getItemPK();
204                
205                if(thisItemPK == null) {
206                    objectsEqual = objectsEqual && (thatItemPK == null);
207                } else {
208                    objectsEqual = objectsEqual && thisItemPK.equals(thatItemPK);
209                }
210            }
211            
212            if(objectsEqual) {
213                UnitOfMeasureTypePK thisUnitOfMeasureTypePK = getUnitOfMeasureTypePK();
214                UnitOfMeasureTypePK thatUnitOfMeasureTypePK = that.getUnitOfMeasureTypePK();
215                
216                if(thisUnitOfMeasureTypePK == null) {
217                    objectsEqual = objectsEqual && (thatUnitOfMeasureTypePK == null);
218                } else {
219                    objectsEqual = objectsEqual && thisUnitOfMeasureTypePK.equals(thatUnitOfMeasureTypePK);
220                }
221            }
222            
223            if(objectsEqual) {
224                ItemVolumeTypePK thisItemVolumeTypePK = getItemVolumeTypePK();
225                ItemVolumeTypePK thatItemVolumeTypePK = that.getItemVolumeTypePK();
226                
227                if(thisItemVolumeTypePK == null) {
228                    objectsEqual = objectsEqual && (thatItemVolumeTypePK == null);
229                } else {
230                    objectsEqual = objectsEqual && thisItemVolumeTypePK.equals(thatItemVolumeTypePK);
231                }
232            }
233            
234            if(objectsEqual) {
235                Long thisHeight = getHeight();
236                Long thatHeight = that.getHeight();
237                
238                if(thisHeight == null) {
239                    objectsEqual = objectsEqual && (thatHeight == null);
240                } else {
241                    objectsEqual = objectsEqual && thisHeight.equals(thatHeight);
242                }
243            }
244            
245            if(objectsEqual) {
246                Long thisWidth = getWidth();
247                Long thatWidth = that.getWidth();
248                
249                if(thisWidth == null) {
250                    objectsEqual = objectsEqual && (thatWidth == null);
251                } else {
252                    objectsEqual = objectsEqual && thisWidth.equals(thatWidth);
253                }
254            }
255            
256            if(objectsEqual) {
257                Long thisDepth = getDepth();
258                Long thatDepth = that.getDepth();
259                
260                if(thisDepth == null) {
261                    objectsEqual = objectsEqual && (thatDepth == null);
262                } else {
263                    objectsEqual = objectsEqual && thisDepth.equals(thatDepth);
264                }
265            }
266            
267            if(objectsEqual) {
268                Long thisFromTime = getFromTime();
269                Long thatFromTime = that.getFromTime();
270                
271                if(thisFromTime == null) {
272                    objectsEqual = objectsEqual && (thatFromTime == null);
273                } else {
274                    objectsEqual = objectsEqual && thisFromTime.equals(thatFromTime);
275                }
276            }
277            
278            if(objectsEqual) {
279                Long thisThruTime = getThruTime();
280                Long thatThruTime = that.getThruTime();
281                
282                if(thisThruTime == null) {
283                    objectsEqual = objectsEqual && (thatThruTime == null);
284                } else {
285                    objectsEqual = objectsEqual && thisThruTime.equals(thatThruTime);
286                }
287            }
288            
289            return objectsEqual;
290        } else {
291            return false;
292        }
293    }
294    
295    @Override
296    public boolean hasBeenModified() {
297        return itemPKHasBeenModified || unitOfMeasureTypePKHasBeenModified || itemVolumeTypePKHasBeenModified || heightHasBeenModified || widthHasBeenModified || depthHasBeenModified || fromTimeHasBeenModified || thruTimeHasBeenModified;
298    }
299    
300    @Override
301    public void clearHasBeenModified() {
302        itemPKHasBeenModified = false;
303        unitOfMeasureTypePKHasBeenModified = false;
304        itemVolumeTypePKHasBeenModified = false;
305        heightHasBeenModified = false;
306        widthHasBeenModified = false;
307        depthHasBeenModified = false;
308        fromTimeHasBeenModified = false;
309        thruTimeHasBeenModified = false;
310    }
311    
312    public ItemPK getItemPK() {
313        return itemPK;
314    }
315    
316    public void setItemPK(ItemPK itemPK)
317            throws PersistenceNotNullException {
318        checkForNull(itemPK);
319        
320        boolean update = true;
321        
322        if(this.itemPK != null) {
323            if(this.itemPK.equals(itemPK)) {
324                update = false;
325            }
326        } else if(itemPK == null) {
327            update = false;
328        }
329        
330        if(update) {
331            this.itemPK = itemPK;
332            itemPKHasBeenModified = true;
333            clearHashAndString();
334        }
335    }
336    
337    public boolean getItemPKHasBeenModified() {
338        return itemPKHasBeenModified;
339    }
340    
341    public UnitOfMeasureTypePK getUnitOfMeasureTypePK() {
342        return unitOfMeasureTypePK;
343    }
344    
345    public void setUnitOfMeasureTypePK(UnitOfMeasureTypePK unitOfMeasureTypePK)
346            throws PersistenceNotNullException {
347        checkForNull(unitOfMeasureTypePK);
348        
349        boolean update = true;
350        
351        if(this.unitOfMeasureTypePK != null) {
352            if(this.unitOfMeasureTypePK.equals(unitOfMeasureTypePK)) {
353                update = false;
354            }
355        } else if(unitOfMeasureTypePK == null) {
356            update = false;
357        }
358        
359        if(update) {
360            this.unitOfMeasureTypePK = unitOfMeasureTypePK;
361            unitOfMeasureTypePKHasBeenModified = true;
362            clearHashAndString();
363        }
364    }
365    
366    public boolean getUnitOfMeasureTypePKHasBeenModified() {
367        return unitOfMeasureTypePKHasBeenModified;
368    }
369    
370    public ItemVolumeTypePK getItemVolumeTypePK() {
371        return itemVolumeTypePK;
372    }
373    
374    public void setItemVolumeTypePK(ItemVolumeTypePK itemVolumeTypePK)
375            throws PersistenceNotNullException {
376        checkForNull(itemVolumeTypePK);
377        
378        boolean update = true;
379        
380        if(this.itemVolumeTypePK != null) {
381            if(this.itemVolumeTypePK.equals(itemVolumeTypePK)) {
382                update = false;
383            }
384        } else if(itemVolumeTypePK == null) {
385            update = false;
386        }
387        
388        if(update) {
389            this.itemVolumeTypePK = itemVolumeTypePK;
390            itemVolumeTypePKHasBeenModified = true;
391            clearHashAndString();
392        }
393    }
394    
395    public boolean getItemVolumeTypePKHasBeenModified() {
396        return itemVolumeTypePKHasBeenModified;
397    }
398    
399    public Long getHeight() {
400        return height;
401    }
402    
403    public void setHeight(Long height)
404            throws PersistenceNotNullException {
405        checkForNull(height);
406        
407        boolean update = true;
408        
409        if(this.height != null) {
410            if(this.height.equals(height)) {
411                update = false;
412            }
413        } else if(height == null) {
414            update = false;
415        }
416        
417        if(update) {
418            this.height = height;
419            heightHasBeenModified = true;
420            clearHashAndString();
421        }
422    }
423    
424    public boolean getHeightHasBeenModified() {
425        return heightHasBeenModified;
426    }
427    
428    public Long getWidth() {
429        return width;
430    }
431    
432    public void setWidth(Long width)
433            throws PersistenceNotNullException {
434        checkForNull(width);
435        
436        boolean update = true;
437        
438        if(this.width != null) {
439            if(this.width.equals(width)) {
440                update = false;
441            }
442        } else if(width == null) {
443            update = false;
444        }
445        
446        if(update) {
447            this.width = width;
448            widthHasBeenModified = true;
449            clearHashAndString();
450        }
451    }
452    
453    public boolean getWidthHasBeenModified() {
454        return widthHasBeenModified;
455    }
456    
457    public Long getDepth() {
458        return depth;
459    }
460    
461    public void setDepth(Long depth)
462            throws PersistenceNotNullException {
463        checkForNull(depth);
464        
465        boolean update = true;
466        
467        if(this.depth != null) {
468            if(this.depth.equals(depth)) {
469                update = false;
470            }
471        } else if(depth == null) {
472            update = false;
473        }
474        
475        if(update) {
476            this.depth = depth;
477            depthHasBeenModified = true;
478            clearHashAndString();
479        }
480    }
481    
482    public boolean getDepthHasBeenModified() {
483        return depthHasBeenModified;
484    }
485    
486    public Long getFromTime() {
487        return fromTime;
488    }
489    
490    public void setFromTime(Long fromTime)
491            throws PersistenceNotNullException {
492        checkForNull(fromTime);
493        
494        boolean update = true;
495        
496        if(this.fromTime != null) {
497            if(this.fromTime.equals(fromTime)) {
498                update = false;
499            }
500        } else if(fromTime == null) {
501            update = false;
502        }
503        
504        if(update) {
505            this.fromTime = fromTime;
506            fromTimeHasBeenModified = true;
507            clearHashAndString();
508        }
509    }
510    
511    public boolean getFromTimeHasBeenModified() {
512        return fromTimeHasBeenModified;
513    }
514    
515    public Long getThruTime() {
516        return thruTime;
517    }
518    
519    public void setThruTime(Long thruTime)
520            throws PersistenceNotNullException {
521        checkForNull(thruTime);
522        
523        boolean update = true;
524        
525        if(this.thruTime != null) {
526            if(this.thruTime.equals(thruTime)) {
527                update = false;
528            }
529        } else if(thruTime == null) {
530            update = false;
531        }
532        
533        if(update) {
534            this.thruTime = thruTime;
535            thruTimeHasBeenModified = true;
536            clearHashAndString();
537        }
538    }
539    
540    public boolean getThruTimeHasBeenModified() {
541        return thruTimeHasBeenModified;
542    }
543    
544}