// --------------------------------------------------------------------------------
// Copyright 2002-2026 Echo Three, LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
// --------------------------------------------------------------------------------
// Generated File -- DO NOT EDIT BY HAND
// --------------------------------------------------------------------------------

/**
 * DocumentDetail.java
 */

package com.echothree.model.data.document.server.entity;

import com.echothree.model.data.document.common.pk.DocumentDetailPK;

import com.echothree.model.data.document.common.pk.DocumentPK;
import com.echothree.model.data.document.common.pk.DocumentTypePK;
import com.echothree.model.data.core.common.pk.MimeTypePK;

import com.echothree.model.data.document.server.entity.Document;
import com.echothree.model.data.document.server.entity.DocumentType;
import com.echothree.model.data.core.server.entity.MimeType;

import com.echothree.model.data.document.server.factory.DocumentFactory;
import com.echothree.model.data.document.server.factory.DocumentTypeFactory;
import com.echothree.model.data.core.server.factory.MimeTypeFactory;

import com.echothree.model.data.document.common.pk.DocumentDetailPK;

import com.echothree.model.data.document.server.value.DocumentDetailValue;

import com.echothree.model.data.document.server.factory.DocumentDetailFactory;

import com.echothree.util.common.exception.PersistenceException;
import com.echothree.util.common.exception.PersistenceDatabaseException;
import com.echothree.util.common.exception.PersistenceNotNullException;
import com.echothree.util.common.exception.PersistenceReadOnlyException;

import com.echothree.util.common.persistence.BasePK;

import com.echothree.util.common.persistence.type.ByteArray;

import com.echothree.util.server.persistence.BaseEntity;
import com.echothree.util.server.persistence.EntityPermission;
import com.echothree.util.server.persistence.Session;
import com.echothree.util.server.persistence.ThreadSession;

import java.io.Serializable;

import javax.annotation.Nonnull;
import javax.annotation.Nullable;

public class DocumentDetail
        extends BaseEntity
        implements Serializable {
    
    private DocumentDetailPK _pk;
    private DocumentDetailValue _value;
    
    /** Creates a new instance of DocumentDetail */
    public DocumentDetail()
            throws PersistenceException {
        super();
    }
    
    /** Creates a new instance of DocumentDetail */
    public DocumentDetail(DocumentDetailValue value, EntityPermission entityPermission) {
        super(entityPermission);
        
        _value = value;
        _pk = value.getPrimaryKey();
    }
    
    @Override
    @Nonnull
    public DocumentDetailFactory getBaseFactoryInstance() {
        return DocumentDetailFactory.getInstance();
    }
    
    @Override
    public boolean hasBeenModified() {
        return _value.hasBeenModified();
    }
    
    @Override
    public int hashCode() {
        return _pk.hashCode();
    }
    
    @Override
    @Nonnull
    public String toString() {
        return _pk.toString();
    }
    
    @Override
    public boolean equals(Object other) {
        if(this == other)
            return true;
        
        if(other instanceof DocumentDetail that) {
            DocumentDetailValue thatValue = that.getDocumentDetailValue();
            return _value.equals(thatValue);
        } else {
            return false;
        }
    }
    
    @Override
    public void store()
            throws PersistenceDatabaseException {
        getBaseFactoryInstance().store(this);
    }
    
    @Override
    public void remove()
            throws PersistenceDatabaseException {
        getBaseFactoryInstance().remove(this);
    }
    
    @Nonnull
    public DocumentDetailValue getDocumentDetailValue() {
        return _value;
    }
    
    public void setDocumentDetailValue(@Nonnull DocumentDetailValue value)
            throws PersistenceReadOnlyException {
        checkReadWrite();
        _value = value;
    }
    
    @Override
    @Nonnull
    public DocumentDetailPK getPrimaryKey() {
        return _pk;
    }
    
    @Nonnull
    public DocumentPK getDocumentPK() {
        return _value.getDocumentPK();
    }
    
    @Nonnull
    public Document getDocument(EntityPermission entityPermission) {
        return DocumentFactory.getInstance().getEntityFromPK(entityPermission, getDocumentPK());
    }
    
    @Nonnull
    public Document getDocument() {
        return getDocument(EntityPermission.READ_ONLY);
    }
    
    @Nonnull
    public Document getDocumentForUpdate() {
        return getDocument(EntityPermission.READ_WRITE);
    }
    
    public void setDocumentPK(@Nonnull DocumentPK documentPK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setDocumentPK(documentPK);
    }
    
    public void setDocument(@Nonnull Document entity) {
        setDocumentPK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getDocumentPKHasBeenModified() {
        return _value.getDocumentPKHasBeenModified();
    }
    
    @Nonnull
    public String getDocumentName() {
        return _value.getDocumentName();
    }
    
    public void setDocumentName(@Nonnull String documentName)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setDocumentName(documentName);
    }
    
    public boolean getDocumentNameHasBeenModified() {
        return _value.getDocumentNameHasBeenModified();
    }
    
    @Nonnull
    public DocumentTypePK getDocumentTypePK() {
        return _value.getDocumentTypePK();
    }
    
    @Nonnull
    public DocumentType getDocumentType(EntityPermission entityPermission) {
        return DocumentTypeFactory.getInstance().getEntityFromPK(entityPermission, getDocumentTypePK());
    }
    
    @Nonnull
    public DocumentType getDocumentType() {
        return getDocumentType(EntityPermission.READ_ONLY);
    }
    
    @Nonnull
    public DocumentType getDocumentTypeForUpdate() {
        return getDocumentType(EntityPermission.READ_WRITE);
    }
    
    public void setDocumentTypePK(@Nonnull DocumentTypePK documentTypePK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setDocumentTypePK(documentTypePK);
    }
    
    public void setDocumentType(@Nonnull DocumentType entity) {
        setDocumentTypePK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getDocumentTypePKHasBeenModified() {
        return _value.getDocumentTypePKHasBeenModified();
    }
    
    @Nonnull
    public MimeTypePK getMimeTypePK() {
        return _value.getMimeTypePK();
    }
    
    @Nonnull
    public MimeType getMimeType(EntityPermission entityPermission) {
        return MimeTypeFactory.getInstance().getEntityFromPK(entityPermission, getMimeTypePK());
    }
    
    @Nonnull
    public MimeType getMimeType() {
        return getMimeType(EntityPermission.READ_ONLY);
    }
    
    @Nonnull
    public MimeType getMimeTypeForUpdate() {
        return getMimeType(EntityPermission.READ_WRITE);
    }
    
    public void setMimeTypePK(@Nonnull MimeTypePK mimeTypePK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setMimeTypePK(mimeTypePK);
    }
    
    public void setMimeType(@Nonnull MimeType entity) {
        setMimeTypePK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getMimeTypePKHasBeenModified() {
        return _value.getMimeTypePKHasBeenModified();
    }
    
    @Nullable
    public Integer getPages() {
        return _value.getPages();
    }
    
    public void setPages(@Nullable Integer pages)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setPages(pages);
    }
    
    public boolean getPagesHasBeenModified() {
        return _value.getPagesHasBeenModified();
    }
    
    @Nonnull
    public Long getFromTime() {
        return _value.getFromTime();
    }
    
    public void setFromTime(@Nonnull Long fromTime)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setFromTime(fromTime);
    }
    
    public boolean getFromTimeHasBeenModified() {
        return _value.getFromTimeHasBeenModified();
    }
    
    @Nonnull
    public Long getThruTime() {
        return _value.getThruTime();
    }
    
    public void setThruTime(@Nonnull Long thruTime)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setThruTime(thruTime);
    }
    
    public boolean getThruTimeHasBeenModified() {
        return _value.getThruTimeHasBeenModified();
    }
    
}