001// --------------------------------------------------------------------------------
002// Copyright 2002-2026 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 * DocumentDetailValue.java
021 */
022
023package com.echothree.model.data.document.server.value;
024
025import com.echothree.model.data.document.common.pk.DocumentDetailPK;
026
027import com.echothree.model.data.document.server.factory.DocumentDetailFactory;
028
029import com.echothree.model.data.document.common.pk.DocumentPK;
030import com.echothree.model.data.document.common.pk.DocumentTypePK;
031import com.echothree.model.data.core.common.pk.MimeTypePK;
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
040import javax.annotation.Nonnull;
041import javax.annotation.Nullable;
042
043public class DocumentDetailValue
044        extends BaseValue<DocumentDetailPK>
045        implements Cloneable, Serializable {
046    
047    private DocumentPK documentPK;
048    private boolean documentPKHasBeenModified = false;
049    private String documentName;
050    private boolean documentNameHasBeenModified = false;
051    private DocumentTypePK documentTypePK;
052    private boolean documentTypePKHasBeenModified = false;
053    private MimeTypePK mimeTypePK;
054    private boolean mimeTypePKHasBeenModified = false;
055    private Integer pages;
056    private boolean pagesHasBeenModified = false;
057    private Long fromTime;
058    private boolean fromTimeHasBeenModified = false;
059    private Long thruTime;
060    private boolean thruTimeHasBeenModified = false;
061    
062    private transient Integer _hashCode = null;
063    private transient String _stringValue = null;
064    
065    private void constructFields(DocumentPK documentPK, String documentName, DocumentTypePK documentTypePK, MimeTypePK mimeTypePK, Integer pages, Long fromTime, Long thruTime)
066            throws PersistenceNotNullException {
067        checkForNull(documentPK);
068        this.documentPK = documentPK;
069        checkForNull(documentName);
070        this.documentName = documentName;
071        checkForNull(documentTypePK);
072        this.documentTypePK = documentTypePK;
073        checkForNull(mimeTypePK);
074        this.mimeTypePK = mimeTypePK;
075        this.pages = pages;
076        checkForNull(fromTime);
077        this.fromTime = fromTime;
078        checkForNull(thruTime);
079        this.thruTime = thruTime;
080    }
081    
082    /** Creates a new instance of DocumentDetailValue */
083    public DocumentDetailValue(DocumentDetailPK documentDetailPK, DocumentPK documentPK, String documentName, DocumentTypePK documentTypePK, MimeTypePK mimeTypePK, Integer pages, Long fromTime, Long thruTime)
084            throws PersistenceNotNullException {
085        super(documentDetailPK);
086        constructFields(documentPK, documentName, documentTypePK, mimeTypePK, pages, fromTime, thruTime);
087    }
088    
089    /** Creates a new instance of DocumentDetailValue */
090    public DocumentDetailValue(DocumentPK documentPK, String documentName, DocumentTypePK documentTypePK, MimeTypePK mimeTypePK, Integer pages, Long fromTime, Long thruTime)
091            throws PersistenceNotNullException {
092        super();
093        constructFields(documentPK, documentName, documentTypePK, mimeTypePK, pages, fromTime, thruTime);
094    }
095    
096    @Override
097    @Nonnull
098    public DocumentDetailFactory getBaseFactoryInstance() {
099        return DocumentDetailFactory.getInstance();
100    }
101    
102    @Override
103    @Nonnull
104    public DocumentDetailValue 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 (DocumentDetailValue)result;
115    }
116    
117    @Override
118    @Nonnull
119    public DocumentDetailPK getPrimaryKey() {
120        if(_primaryKey == null) {
121            _primaryKey = new DocumentDetailPK(entityId);
122        }
123        
124        return _primaryKey;
125    }
126    
127    private void clearHashAndString() {
128        _hashCode = null;
129        _stringValue = null;
130    }
131    
132    @Override
133    public int hashCode() {
134        if(_hashCode == null) {
135            int hashCode = 17;
136            
137            hashCode = 37 * hashCode + ((entityId != null) ? entityId.hashCode() : 0);
138            
139            hashCode = 37 * hashCode + ((documentPK != null) ? documentPK.hashCode() : 0);
140            hashCode = 37 * hashCode + ((documentName != null) ? documentName.hashCode() : 0);
141            hashCode = 37 * hashCode + ((documentTypePK != null) ? documentTypePK.hashCode() : 0);
142            hashCode = 37 * hashCode + ((mimeTypePK != null) ? mimeTypePK.hashCode() : 0);
143            hashCode = 37 * hashCode + ((pages != null) ? pages.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    @Nonnull
155    public String toString() {
156        if(_stringValue == null) {
157            _stringValue = "{" + 
158                    "entityId=" + getEntityId() +
159                    ", documentPK=" + getDocumentPK() +
160                    ", documentName=" + getDocumentName() +
161                    ", documentTypePK=" + getDocumentTypePK() +
162                    ", mimeTypePK=" + getMimeTypePK() +
163                    ", pages=" + getPages() +
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  DocumentDetailValue 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 DocumentDetailValue that) {
198            boolean objectsEqual = true;
199            
200            
201            if(objectsEqual) {
202                DocumentPK thisDocumentPK = getDocumentPK();
203                DocumentPK thatDocumentPK = that.getDocumentPK();
204                
205                if(thisDocumentPK == null) {
206                    objectsEqual = objectsEqual && (thatDocumentPK == null);
207                } else {
208                    objectsEqual = objectsEqual && thisDocumentPK.equals(thatDocumentPK);
209                }
210            }
211            
212            if(objectsEqual) {
213                String thisDocumentName = getDocumentName();
214                String thatDocumentName = that.getDocumentName();
215                
216                if(thisDocumentName == null) {
217                    objectsEqual = objectsEqual && (thatDocumentName == null);
218                } else {
219                    objectsEqual = objectsEqual && thisDocumentName.equals(thatDocumentName);
220                }
221            }
222            
223            if(objectsEqual) {
224                DocumentTypePK thisDocumentTypePK = getDocumentTypePK();
225                DocumentTypePK thatDocumentTypePK = that.getDocumentTypePK();
226                
227                if(thisDocumentTypePK == null) {
228                    objectsEqual = objectsEqual && (thatDocumentTypePK == null);
229                } else {
230                    objectsEqual = objectsEqual && thisDocumentTypePK.equals(thatDocumentTypePK);
231                }
232            }
233            
234            if(objectsEqual) {
235                MimeTypePK thisMimeTypePK = getMimeTypePK();
236                MimeTypePK thatMimeTypePK = that.getMimeTypePK();
237                
238                if(thisMimeTypePK == null) {
239                    objectsEqual = objectsEqual && (thatMimeTypePK == null);
240                } else {
241                    objectsEqual = objectsEqual && thisMimeTypePK.equals(thatMimeTypePK);
242                }
243            }
244            
245            if(objectsEqual) {
246                Integer thisPages = getPages();
247                Integer thatPages = that.getPages();
248                
249                if(thisPages == null) {
250                    objectsEqual = objectsEqual && (thatPages == null);
251                } else {
252                    objectsEqual = objectsEqual && thisPages.equals(thatPages);
253                }
254            }
255            
256            if(objectsEqual) {
257                Long thisFromTime = getFromTime();
258                Long thatFromTime = that.getFromTime();
259                
260                if(thisFromTime == null) {
261                    objectsEqual = objectsEqual && (thatFromTime == null);
262                } else {
263                    objectsEqual = objectsEqual && thisFromTime.equals(thatFromTime);
264                }
265            }
266            
267            if(objectsEqual) {
268                Long thisThruTime = getThruTime();
269                Long thatThruTime = that.getThruTime();
270                
271                if(thisThruTime == null) {
272                    objectsEqual = objectsEqual && (thatThruTime == null);
273                } else {
274                    objectsEqual = objectsEqual && thisThruTime.equals(thatThruTime);
275                }
276            }
277            
278            return objectsEqual;
279        } else {
280            return false;
281        }
282    }
283    
284    @Override
285    public boolean hasBeenModified() {
286        return documentPKHasBeenModified || documentNameHasBeenModified || documentTypePKHasBeenModified || mimeTypePKHasBeenModified || pagesHasBeenModified || fromTimeHasBeenModified || thruTimeHasBeenModified;
287    }
288    
289    @Override
290    public void clearHasBeenModified() {
291        documentPKHasBeenModified = false;
292        documentNameHasBeenModified = false;
293        documentTypePKHasBeenModified = false;
294        mimeTypePKHasBeenModified = false;
295        pagesHasBeenModified = false;
296        fromTimeHasBeenModified = false;
297        thruTimeHasBeenModified = false;
298    }
299    
300    @Nonnull
301    public DocumentPK getDocumentPK() {
302        return documentPK;
303    }
304    
305    public void setDocumentPK(@Nonnull DocumentPK documentPK)
306            throws PersistenceNotNullException {
307        checkForNull(documentPK);
308        
309        boolean update = true;
310        
311        if(this.documentPK != null) {
312            if(this.documentPK.equals(documentPK)) {
313                update = false;
314            }
315        } else if(documentPK == null) {
316            update = false;
317        }
318        
319        if(update) {
320            this.documentPK = documentPK;
321            documentPKHasBeenModified = true;
322            clearHashAndString();
323        }
324    }
325    
326    public boolean getDocumentPKHasBeenModified() {
327        return documentPKHasBeenModified;
328    }
329    
330    @Nonnull
331    public String getDocumentName() {
332        return documentName;
333    }
334    
335    public void setDocumentName(@Nonnull String documentName)
336            throws PersistenceNotNullException {
337        checkForNull(documentName);
338        
339        boolean update = true;
340        
341        if(this.documentName != null) {
342            if(this.documentName.equals(documentName)) {
343                update = false;
344            }
345        } else if(documentName == null) {
346            update = false;
347        }
348        
349        if(update) {
350            this.documentName = documentName;
351            documentNameHasBeenModified = true;
352            clearHashAndString();
353        }
354    }
355    
356    public boolean getDocumentNameHasBeenModified() {
357        return documentNameHasBeenModified;
358    }
359    
360    @Nonnull
361    public DocumentTypePK getDocumentTypePK() {
362        return documentTypePK;
363    }
364    
365    public void setDocumentTypePK(@Nonnull DocumentTypePK documentTypePK)
366            throws PersistenceNotNullException {
367        checkForNull(documentTypePK);
368        
369        boolean update = true;
370        
371        if(this.documentTypePK != null) {
372            if(this.documentTypePK.equals(documentTypePK)) {
373                update = false;
374            }
375        } else if(documentTypePK == null) {
376            update = false;
377        }
378        
379        if(update) {
380            this.documentTypePK = documentTypePK;
381            documentTypePKHasBeenModified = true;
382            clearHashAndString();
383        }
384    }
385    
386    public boolean getDocumentTypePKHasBeenModified() {
387        return documentTypePKHasBeenModified;
388    }
389    
390    @Nonnull
391    public MimeTypePK getMimeTypePK() {
392        return mimeTypePK;
393    }
394    
395    public void setMimeTypePK(@Nonnull MimeTypePK mimeTypePK)
396            throws PersistenceNotNullException {
397        checkForNull(mimeTypePK);
398        
399        boolean update = true;
400        
401        if(this.mimeTypePK != null) {
402            if(this.mimeTypePK.equals(mimeTypePK)) {
403                update = false;
404            }
405        } else if(mimeTypePK == null) {
406            update = false;
407        }
408        
409        if(update) {
410            this.mimeTypePK = mimeTypePK;
411            mimeTypePKHasBeenModified = true;
412            clearHashAndString();
413        }
414    }
415    
416    public boolean getMimeTypePKHasBeenModified() {
417        return mimeTypePKHasBeenModified;
418    }
419    
420    @Nullable
421    public Integer getPages() {
422        return pages;
423    }
424    
425    public void setPages(@Nullable Integer pages) {
426        boolean update = true;
427        
428        if(this.pages != null) {
429            if(this.pages.equals(pages)) {
430                update = false;
431            }
432        } else if(pages == null) {
433            update = false;
434        }
435        
436        if(update) {
437            this.pages = pages;
438            pagesHasBeenModified = true;
439            clearHashAndString();
440        }
441    }
442    
443    public boolean getPagesHasBeenModified() {
444        return pagesHasBeenModified;
445    }
446    
447    @Nonnull
448    public Long getFromTime() {
449        return fromTime;
450    }
451    
452    public void setFromTime(@Nonnull Long fromTime)
453            throws PersistenceNotNullException {
454        checkForNull(fromTime);
455        
456        boolean update = true;
457        
458        if(this.fromTime != null) {
459            if(this.fromTime.equals(fromTime)) {
460                update = false;
461            }
462        } else if(fromTime == null) {
463            update = false;
464        }
465        
466        if(update) {
467            this.fromTime = fromTime;
468            fromTimeHasBeenModified = true;
469            clearHashAndString();
470        }
471    }
472    
473    public boolean getFromTimeHasBeenModified() {
474        return fromTimeHasBeenModified;
475    }
476    
477    @Nonnull
478    public Long getThruTime() {
479        return thruTime;
480    }
481    
482    public void setThruTime(@Nonnull Long thruTime)
483            throws PersistenceNotNullException {
484        checkForNull(thruTime);
485        
486        boolean update = true;
487        
488        if(this.thruTime != null) {
489            if(this.thruTime.equals(thruTime)) {
490                update = false;
491            }
492        } else if(thruTime == null) {
493            update = false;
494        }
495        
496        if(update) {
497            this.thruTime = thruTime;
498            thruTimeHasBeenModified = true;
499            clearHashAndString();
500        }
501    }
502    
503    public boolean getThruTimeHasBeenModified() {
504        return thruTimeHasBeenModified;
505    }
506    
507}