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 * DocumentDetail.java
021 */
022
023package com.echothree.model.data.document.server.entity;
024
025import com.echothree.model.data.document.common.pk.DocumentDetailPK;
026
027import com.echothree.model.data.document.common.pk.DocumentPK;
028import com.echothree.model.data.document.common.pk.DocumentTypePK;
029import com.echothree.model.data.core.common.pk.MimeTypePK;
030
031import com.echothree.model.data.document.server.entity.Document;
032import com.echothree.model.data.document.server.entity.DocumentType;
033import com.echothree.model.data.core.server.entity.MimeType;
034
035import com.echothree.model.data.document.server.factory.DocumentFactory;
036import com.echothree.model.data.document.server.factory.DocumentTypeFactory;
037import com.echothree.model.data.core.server.factory.MimeTypeFactory;
038
039import com.echothree.model.data.document.common.pk.DocumentDetailPK;
040
041import com.echothree.model.data.document.server.value.DocumentDetailValue;
042
043import com.echothree.model.data.document.server.factory.DocumentDetailFactory;
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 DocumentDetail
062        extends BaseEntity
063        implements Serializable {
064    
065    private DocumentDetailPK _pk;
066    private DocumentDetailValue _value;
067    
068    /** Creates a new instance of DocumentDetail */
069    public DocumentDetail()
070            throws PersistenceException {
071        super();
072    }
073    
074    /** Creates a new instance of DocumentDetail */
075    public DocumentDetail(DocumentDetailValue value, EntityPermission entityPermission) {
076        super(entityPermission);
077        
078        _value = value;
079        _pk = value.getPrimaryKey();
080    }
081    
082    @Override
083    public DocumentDetailFactory getBaseFactoryInstance() {
084        return DocumentDetailFactory.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 DocumentDetail that) {
108            DocumentDetailValue thatValue = that.getDocumentDetailValue();
109            return _value.equals(thatValue);
110        } else {
111            return false;
112        }
113    }
114    
115    @Override
116    public void store(Session session)
117            throws PersistenceDatabaseException {
118        getBaseFactoryInstance().store(session, this);
119    }
120    
121    @Override
122    public void remove(Session session)
123            throws PersistenceDatabaseException {
124        getBaseFactoryInstance().remove(session, this);
125    }
126    
127    @Override
128    public void remove()
129            throws PersistenceDatabaseException {
130        getBaseFactoryInstance().remove(ThreadSession.currentSession(), this);
131    }
132    
133    public DocumentDetailValue getDocumentDetailValue() {
134        return _value;
135    }
136    
137    public void setDocumentDetailValue(DocumentDetailValue value)
138            throws PersistenceReadOnlyException {
139        checkReadWrite();
140        _value = value;
141    }
142    
143    @Override
144    public DocumentDetailPK getPrimaryKey() {
145        return _pk;
146    }
147    
148    public DocumentPK getDocumentPK() {
149        return _value.getDocumentPK();
150    }
151    
152    public Document getDocument(Session session, EntityPermission entityPermission) {
153        return DocumentFactory.getInstance().getEntityFromPK(session, entityPermission, getDocumentPK());
154    }
155    
156    public Document getDocument(EntityPermission entityPermission) {
157        return getDocument(ThreadSession.currentSession(), entityPermission);
158    }
159    
160    public Document getDocument(Session session) {
161        return getDocument(session, EntityPermission.READ_ONLY);
162    }
163    
164    public Document getDocument() {
165        return getDocument(ThreadSession.currentSession(), EntityPermission.READ_ONLY);
166    }
167    
168    public Document getDocumentForUpdate(Session session) {
169        return getDocument(session, EntityPermission.READ_WRITE);
170    }
171    
172    public Document getDocumentForUpdate() {
173        return getDocument(ThreadSession.currentSession(), EntityPermission.READ_WRITE);
174    }
175    
176    public void setDocumentPK(DocumentPK documentPK)
177            throws PersistenceNotNullException, PersistenceReadOnlyException {
178        checkReadWrite();
179        _value.setDocumentPK(documentPK);
180    }
181    
182    public void setDocument(Document entity) {
183        setDocumentPK(entity == null? null: entity.getPrimaryKey());
184    }
185    
186    public boolean getDocumentPKHasBeenModified() {
187        return _value.getDocumentPKHasBeenModified();
188    }
189    
190    public String getDocumentName() {
191        return _value.getDocumentName();
192    }
193    
194    public void setDocumentName(String documentName)
195            throws PersistenceNotNullException, PersistenceReadOnlyException {
196        checkReadWrite();
197        _value.setDocumentName(documentName);
198    }
199    
200    public boolean getDocumentNameHasBeenModified() {
201        return _value.getDocumentNameHasBeenModified();
202    }
203    
204    public DocumentTypePK getDocumentTypePK() {
205        return _value.getDocumentTypePK();
206    }
207    
208    public DocumentType getDocumentType(Session session, EntityPermission entityPermission) {
209        return DocumentTypeFactory.getInstance().getEntityFromPK(session, entityPermission, getDocumentTypePK());
210    }
211    
212    public DocumentType getDocumentType(EntityPermission entityPermission) {
213        return getDocumentType(ThreadSession.currentSession(), entityPermission);
214    }
215    
216    public DocumentType getDocumentType(Session session) {
217        return getDocumentType(session, EntityPermission.READ_ONLY);
218    }
219    
220    public DocumentType getDocumentType() {
221        return getDocumentType(ThreadSession.currentSession(), EntityPermission.READ_ONLY);
222    }
223    
224    public DocumentType getDocumentTypeForUpdate(Session session) {
225        return getDocumentType(session, EntityPermission.READ_WRITE);
226    }
227    
228    public DocumentType getDocumentTypeForUpdate() {
229        return getDocumentType(ThreadSession.currentSession(), EntityPermission.READ_WRITE);
230    }
231    
232    public void setDocumentTypePK(DocumentTypePK documentTypePK)
233            throws PersistenceNotNullException, PersistenceReadOnlyException {
234        checkReadWrite();
235        _value.setDocumentTypePK(documentTypePK);
236    }
237    
238    public void setDocumentType(DocumentType entity) {
239        setDocumentTypePK(entity == null? null: entity.getPrimaryKey());
240    }
241    
242    public boolean getDocumentTypePKHasBeenModified() {
243        return _value.getDocumentTypePKHasBeenModified();
244    }
245    
246    public MimeTypePK getMimeTypePK() {
247        return _value.getMimeTypePK();
248    }
249    
250    public MimeType getMimeType(Session session, EntityPermission entityPermission) {
251        return MimeTypeFactory.getInstance().getEntityFromPK(session, entityPermission, getMimeTypePK());
252    }
253    
254    public MimeType getMimeType(EntityPermission entityPermission) {
255        return getMimeType(ThreadSession.currentSession(), entityPermission);
256    }
257    
258    public MimeType getMimeType(Session session) {
259        return getMimeType(session, EntityPermission.READ_ONLY);
260    }
261    
262    public MimeType getMimeType() {
263        return getMimeType(ThreadSession.currentSession(), EntityPermission.READ_ONLY);
264    }
265    
266    public MimeType getMimeTypeForUpdate(Session session) {
267        return getMimeType(session, EntityPermission.READ_WRITE);
268    }
269    
270    public MimeType getMimeTypeForUpdate() {
271        return getMimeType(ThreadSession.currentSession(), EntityPermission.READ_WRITE);
272    }
273    
274    public void setMimeTypePK(MimeTypePK mimeTypePK)
275            throws PersistenceNotNullException, PersistenceReadOnlyException {
276        checkReadWrite();
277        _value.setMimeTypePK(mimeTypePK);
278    }
279    
280    public void setMimeType(MimeType entity) {
281        setMimeTypePK(entity == null? null: entity.getPrimaryKey());
282    }
283    
284    public boolean getMimeTypePKHasBeenModified() {
285        return _value.getMimeTypePKHasBeenModified();
286    }
287    
288    public Integer getPages() {
289        return _value.getPages();
290    }
291    
292    public void setPages(Integer pages)
293            throws PersistenceNotNullException, PersistenceReadOnlyException {
294        checkReadWrite();
295        _value.setPages(pages);
296    }
297    
298    public boolean getPagesHasBeenModified() {
299        return _value.getPagesHasBeenModified();
300    }
301    
302    public Long getFromTime() {
303        return _value.getFromTime();
304    }
305    
306    public void setFromTime(Long fromTime)
307            throws PersistenceNotNullException, PersistenceReadOnlyException {
308        checkReadWrite();
309        _value.setFromTime(fromTime);
310    }
311    
312    public boolean getFromTimeHasBeenModified() {
313        return _value.getFromTimeHasBeenModified();
314    }
315    
316    public Long getThruTime() {
317        return _value.getThruTime();
318    }
319    
320    public void setThruTime(Long thruTime)
321            throws PersistenceNotNullException, PersistenceReadOnlyException {
322        checkReadWrite();
323        _value.setThruTime(thruTime);
324    }
325    
326    public boolean getThruTimeHasBeenModified() {
327        return _value.getThruTimeHasBeenModified();
328    }
329    
330}