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