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 * FreeOnBoardDetailValue.java
021 */
022
023package com.echothree.model.data.shipment.server.value;
024
025import com.echothree.model.data.shipment.common.pk.FreeOnBoardDetailPK;
026
027import com.echothree.model.data.shipment.server.factory.FreeOnBoardDetailFactory;
028
029import com.echothree.model.data.shipment.common.pk.FreeOnBoardPK;
030
031import com.echothree.util.common.exception.PersistenceCloneException;
032import com.echothree.util.common.exception.PersistenceNotNullException;
033
034import com.echothree.util.server.persistence.BaseValue;
035
036import java.io.Serializable;
037
038public class FreeOnBoardDetailValue
039        extends BaseValue<FreeOnBoardDetailPK>
040        implements Cloneable, Serializable {
041    
042    private FreeOnBoardPK freeOnBoardPK;
043    private boolean freeOnBoardPKHasBeenModified = false;
044    private String freeOnBoardName;
045    private boolean freeOnBoardNameHasBeenModified = false;
046    private Boolean isDefault;
047    private boolean isDefaultHasBeenModified = false;
048    private Integer sortOrder;
049    private boolean sortOrderHasBeenModified = false;
050    private Long fromTime;
051    private boolean fromTimeHasBeenModified = false;
052    private Long thruTime;
053    private boolean thruTimeHasBeenModified = false;
054    
055    private transient Integer _hashCode = null;
056    private transient String _stringValue = null;
057    
058    private void constructFields(FreeOnBoardPK freeOnBoardPK, String freeOnBoardName, Boolean isDefault, Integer sortOrder, Long fromTime, Long thruTime)
059            throws PersistenceNotNullException {
060        checkForNull(freeOnBoardPK);
061        this.freeOnBoardPK = freeOnBoardPK;
062        checkForNull(freeOnBoardName);
063        this.freeOnBoardName = freeOnBoardName;
064        checkForNull(isDefault);
065        this.isDefault = isDefault;
066        checkForNull(sortOrder);
067        this.sortOrder = sortOrder;
068        checkForNull(fromTime);
069        this.fromTime = fromTime;
070        checkForNull(thruTime);
071        this.thruTime = thruTime;
072    }
073    
074    /** Creates a new instance of FreeOnBoardDetailValue */
075    public FreeOnBoardDetailValue(FreeOnBoardDetailPK freeOnBoardDetailPK, FreeOnBoardPK freeOnBoardPK, String freeOnBoardName, Boolean isDefault, Integer sortOrder, Long fromTime, Long thruTime)
076            throws PersistenceNotNullException {
077        super(freeOnBoardDetailPK);
078        constructFields(freeOnBoardPK, freeOnBoardName, isDefault, sortOrder, fromTime, thruTime);
079    }
080    
081    /** Creates a new instance of FreeOnBoardDetailValue */
082    public FreeOnBoardDetailValue(FreeOnBoardPK freeOnBoardPK, String freeOnBoardName, Boolean isDefault, Integer sortOrder, Long fromTime, Long thruTime)
083            throws PersistenceNotNullException {
084        super();
085        constructFields(freeOnBoardPK, freeOnBoardName, isDefault, sortOrder, fromTime, thruTime);
086    }
087    
088   @Override
089   public FreeOnBoardDetailFactory getBaseFactoryInstance() {
090        return FreeOnBoardDetailFactory.getInstance();
091    }
092    
093    @Override
094    public FreeOnBoardDetailValue clone() {
095        Object result;
096        
097        try {
098            result = super.clone();
099        } catch (CloneNotSupportedException cnse) {
100            // This shouldn't happen, fail when it does.
101            throw new PersistenceCloneException(cnse);
102        }
103        
104        return (FreeOnBoardDetailValue)result;
105    }
106    
107   @Override
108    public FreeOnBoardDetailPK getPrimaryKey() {
109        if(_primaryKey == null) {
110            _primaryKey = new FreeOnBoardDetailPK(entityId);
111        }
112        
113        return _primaryKey;
114    }
115    
116    private void clearHashAndString() {
117        _hashCode = null;
118        _stringValue = null;
119    }
120    
121    @Override
122    public int hashCode() {
123        if(_hashCode == null) {
124            int hashCode = 17;
125            
126            hashCode = 37 * hashCode + ((entityId != null) ? entityId.hashCode() : 0);
127            
128            hashCode = 37 * hashCode + ((freeOnBoardPK != null) ? freeOnBoardPK.hashCode() : 0);
129            hashCode = 37 * hashCode + ((freeOnBoardName != null) ? freeOnBoardName.hashCode() : 0);
130            hashCode = 37 * hashCode + ((isDefault != null) ? isDefault.hashCode() : 0);
131            hashCode = 37 * hashCode + ((sortOrder != null) ? sortOrder.hashCode() : 0);
132            hashCode = 37 * hashCode + ((fromTime != null) ? fromTime.hashCode() : 0);
133            hashCode = 37 * hashCode + ((thruTime != null) ? thruTime.hashCode() : 0);
134            
135            _hashCode = hashCode;
136        }
137        
138        return _hashCode;
139    }
140    
141    @Override
142    public String toString() {
143        if(_stringValue == null) {
144            _stringValue = "{" + 
145                    "entityId=" + getEntityId() +
146                    ", freeOnBoardPK=" + getFreeOnBoardPK() +
147                    ", freeOnBoardName=" + getFreeOnBoardName() +
148                    ", isDefault=" + getIsDefault() +
149                    ", sortOrder=" + getSortOrder() +
150                    ", fromTime=" + getFromTime() +
151                    ", thruTime=" + getThruTime() +
152                    "}";
153        }
154        return _stringValue;
155    }
156    
157    @Override
158    public boolean equals(Object other) {
159        if(this == other)
160            return true;
161        
162        if(!hasIdentity())
163            return false;
164        
165        if(other instanceof  FreeOnBoardDetailValue that) {
166            if(!that.hasIdentity())
167                return false;
168            
169            Long thisEntityId = getEntityId();
170            Long thatEntityId = that.getEntityId();
171            
172            boolean objectsEqual = thisEntityId.equals(thatEntityId);
173            if(objectsEqual)
174                objectsEqual = isIdentical(that);
175            
176            return objectsEqual;
177        } else {
178            return false;
179        }
180    }
181    
182    public boolean isIdentical(Object other) {
183        if(other instanceof FreeOnBoardDetailValue that) {
184            boolean objectsEqual = true;
185            
186            
187            if(objectsEqual) {
188                FreeOnBoardPK thisFreeOnBoardPK = getFreeOnBoardPK();
189                FreeOnBoardPK thatFreeOnBoardPK = that.getFreeOnBoardPK();
190                
191                if(thisFreeOnBoardPK == null) {
192                    objectsEqual = objectsEqual && (thatFreeOnBoardPK == null);
193                } else {
194                    objectsEqual = objectsEqual && thisFreeOnBoardPK.equals(thatFreeOnBoardPK);
195                }
196            }
197            
198            if(objectsEqual) {
199                String thisFreeOnBoardName = getFreeOnBoardName();
200                String thatFreeOnBoardName = that.getFreeOnBoardName();
201                
202                if(thisFreeOnBoardName == null) {
203                    objectsEqual = objectsEqual && (thatFreeOnBoardName == null);
204                } else {
205                    objectsEqual = objectsEqual && thisFreeOnBoardName.equals(thatFreeOnBoardName);
206                }
207            }
208            
209            if(objectsEqual) {
210                Boolean thisIsDefault = getIsDefault();
211                Boolean thatIsDefault = that.getIsDefault();
212                
213                if(thisIsDefault == null) {
214                    objectsEqual = objectsEqual && (thatIsDefault == null);
215                } else {
216                    objectsEqual = objectsEqual && thisIsDefault.equals(thatIsDefault);
217                }
218            }
219            
220            if(objectsEqual) {
221                Integer thisSortOrder = getSortOrder();
222                Integer thatSortOrder = that.getSortOrder();
223                
224                if(thisSortOrder == null) {
225                    objectsEqual = objectsEqual && (thatSortOrder == null);
226                } else {
227                    objectsEqual = objectsEqual && thisSortOrder.equals(thatSortOrder);
228                }
229            }
230            
231            if(objectsEqual) {
232                Long thisFromTime = getFromTime();
233                Long thatFromTime = that.getFromTime();
234                
235                if(thisFromTime == null) {
236                    objectsEqual = objectsEqual && (thatFromTime == null);
237                } else {
238                    objectsEqual = objectsEqual && thisFromTime.equals(thatFromTime);
239                }
240            }
241            
242            if(objectsEqual) {
243                Long thisThruTime = getThruTime();
244                Long thatThruTime = that.getThruTime();
245                
246                if(thisThruTime == null) {
247                    objectsEqual = objectsEqual && (thatThruTime == null);
248                } else {
249                    objectsEqual = objectsEqual && thisThruTime.equals(thatThruTime);
250                }
251            }
252            
253            return objectsEqual;
254        } else {
255            return false;
256        }
257    }
258    
259    @Override
260    public boolean hasBeenModified() {
261        return freeOnBoardPKHasBeenModified || freeOnBoardNameHasBeenModified || isDefaultHasBeenModified || sortOrderHasBeenModified || fromTimeHasBeenModified || thruTimeHasBeenModified;
262    }
263    
264    @Override
265    public void clearHasBeenModified() {
266        freeOnBoardPKHasBeenModified = false;
267        freeOnBoardNameHasBeenModified = false;
268        isDefaultHasBeenModified = false;
269        sortOrderHasBeenModified = false;
270        fromTimeHasBeenModified = false;
271        thruTimeHasBeenModified = false;
272    }
273    
274    public FreeOnBoardPK getFreeOnBoardPK() {
275        return freeOnBoardPK;
276    }
277    
278    public void setFreeOnBoardPK(FreeOnBoardPK freeOnBoardPK)
279            throws PersistenceNotNullException {
280        checkForNull(freeOnBoardPK);
281        
282        boolean update = true;
283        
284        if(this.freeOnBoardPK != null) {
285            if(this.freeOnBoardPK.equals(freeOnBoardPK)) {
286                update = false;
287            }
288        } else if(freeOnBoardPK == null) {
289            update = false;
290        }
291        
292        if(update) {
293            this.freeOnBoardPK = freeOnBoardPK;
294            freeOnBoardPKHasBeenModified = true;
295            clearHashAndString();
296        }
297    }
298    
299    public boolean getFreeOnBoardPKHasBeenModified() {
300        return freeOnBoardPKHasBeenModified;
301    }
302    
303    public String getFreeOnBoardName() {
304        return freeOnBoardName;
305    }
306    
307    public void setFreeOnBoardName(String freeOnBoardName)
308            throws PersistenceNotNullException {
309        checkForNull(freeOnBoardName);
310        
311        boolean update = true;
312        
313        if(this.freeOnBoardName != null) {
314            if(this.freeOnBoardName.equals(freeOnBoardName)) {
315                update = false;
316            }
317        } else if(freeOnBoardName == null) {
318            update = false;
319        }
320        
321        if(update) {
322            this.freeOnBoardName = freeOnBoardName;
323            freeOnBoardNameHasBeenModified = true;
324            clearHashAndString();
325        }
326    }
327    
328    public boolean getFreeOnBoardNameHasBeenModified() {
329        return freeOnBoardNameHasBeenModified;
330    }
331    
332    public Boolean getIsDefault() {
333        return isDefault;
334    }
335    
336    public void setIsDefault(Boolean isDefault)
337            throws PersistenceNotNullException {
338        checkForNull(isDefault);
339        
340        boolean update = true;
341        
342        if(this.isDefault != null) {
343            if(this.isDefault.equals(isDefault)) {
344                update = false;
345            }
346        } else if(isDefault == null) {
347            update = false;
348        }
349        
350        if(update) {
351            this.isDefault = isDefault;
352            isDefaultHasBeenModified = true;
353            clearHashAndString();
354        }
355    }
356    
357    public boolean getIsDefaultHasBeenModified() {
358        return isDefaultHasBeenModified;
359    }
360    
361    public Integer getSortOrder() {
362        return sortOrder;
363    }
364    
365    public void setSortOrder(Integer sortOrder)
366            throws PersistenceNotNullException {
367        checkForNull(sortOrder);
368        
369        boolean update = true;
370        
371        if(this.sortOrder != null) {
372            if(this.sortOrder.equals(sortOrder)) {
373                update = false;
374            }
375        } else if(sortOrder == null) {
376            update = false;
377        }
378        
379        if(update) {
380            this.sortOrder = sortOrder;
381            sortOrderHasBeenModified = true;
382            clearHashAndString();
383        }
384    }
385    
386    public boolean getSortOrderHasBeenModified() {
387        return sortOrderHasBeenModified;
388    }
389    
390    public Long getFromTime() {
391        return fromTime;
392    }
393    
394    public void setFromTime(Long fromTime)
395            throws PersistenceNotNullException {
396        checkForNull(fromTime);
397        
398        boolean update = true;
399        
400        if(this.fromTime != null) {
401            if(this.fromTime.equals(fromTime)) {
402                update = false;
403            }
404        } else if(fromTime == null) {
405            update = false;
406        }
407        
408        if(update) {
409            this.fromTime = fromTime;
410            fromTimeHasBeenModified = true;
411            clearHashAndString();
412        }
413    }
414    
415    public boolean getFromTimeHasBeenModified() {
416        return fromTimeHasBeenModified;
417    }
418    
419    public Long getThruTime() {
420        return thruTime;
421    }
422    
423    public void setThruTime(Long thruTime)
424            throws PersistenceNotNullException {
425        checkForNull(thruTime);
426        
427        boolean update = true;
428        
429        if(this.thruTime != null) {
430            if(this.thruTime.equals(thruTime)) {
431                update = false;
432            }
433        } else if(thruTime == null) {
434            update = false;
435        }
436        
437        if(update) {
438            this.thruTime = thruTime;
439            thruTimeHasBeenModified = true;
440            clearHashAndString();
441        }
442    }
443    
444    public boolean getThruTimeHasBeenModified() {
445        return thruTimeHasBeenModified;
446    }
447    
448}