// --------------------------------------------------------------------------------
// 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
// --------------------------------------------------------------------------------

/**
 * IconDetail.java
 */

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

import com.echothree.model.data.icon.common.pk.IconDetailPK;

import com.echothree.model.data.icon.common.pk.IconPK;
import com.echothree.model.data.document.common.pk.DocumentPK;

import com.echothree.model.data.icon.server.entity.Icon;
import com.echothree.model.data.document.server.entity.Document;

import com.echothree.model.data.icon.server.factory.IconFactory;
import com.echothree.model.data.document.server.factory.DocumentFactory;

import com.echothree.model.data.icon.common.pk.IconDetailPK;

import com.echothree.model.data.icon.server.value.IconDetailValue;

import com.echothree.model.data.icon.server.factory.IconDetailFactory;

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 IconDetail
        extends BaseEntity
        implements Serializable {
    
    private IconDetailPK _pk;
    private IconDetailValue _value;
    
    /** Creates a new instance of IconDetail */
    public IconDetail()
            throws PersistenceException {
        super();
    }
    
    /** Creates a new instance of IconDetail */
    public IconDetail(IconDetailValue value, EntityPermission entityPermission) {
        super(entityPermission);
        
        _value = value;
        _pk = value.getPrimaryKey();
    }
    
    @Override
    @Nonnull
    public IconDetailFactory getBaseFactoryInstance() {
        return IconDetailFactory.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 IconDetail that) {
            IconDetailValue thatValue = that.getIconDetailValue();
            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 IconDetailValue getIconDetailValue() {
        return _value;
    }
    
    public void setIconDetailValue(@Nonnull IconDetailValue value)
            throws PersistenceReadOnlyException {
        checkReadWrite();
        _value = value;
    }
    
    @Override
    @Nonnull
    public IconDetailPK getPrimaryKey() {
        return _pk;
    }
    
    @Nonnull
    public IconPK getIconPK() {
        return _value.getIconPK();
    }
    
    @Nonnull
    public Icon getIcon(EntityPermission entityPermission) {
        return IconFactory.getInstance().getEntityFromPK(entityPermission, getIconPK());
    }
    
    @Nonnull
    public Icon getIcon() {
        return getIcon(EntityPermission.READ_ONLY);
    }
    
    @Nonnull
    public Icon getIconForUpdate() {
        return getIcon(EntityPermission.READ_WRITE);
    }
    
    public void setIconPK(@Nonnull IconPK iconPK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setIconPK(iconPK);
    }
    
    public void setIcon(@Nonnull Icon entity) {
        setIconPK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getIconPKHasBeenModified() {
        return _value.getIconPKHasBeenModified();
    }
    
    @Nonnull
    public String getIconName() {
        return _value.getIconName();
    }
    
    public void setIconName(@Nonnull String iconName)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setIconName(iconName);
    }
    
    public boolean getIconNameHasBeenModified() {
        return _value.getIconNameHasBeenModified();
    }
    
    @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 Boolean getIsDefault() {
        return _value.getIsDefault();
    }
    
    public void setIsDefault(@Nonnull Boolean isDefault)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setIsDefault(isDefault);
    }
    
    public boolean getIsDefaultHasBeenModified() {
        return _value.getIsDefaultHasBeenModified();
    }
    
    @Nonnull
    public Integer getSortOrder() {
        return _value.getSortOrder();
    }
    
    public void setSortOrder(@Nonnull Integer sortOrder)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setSortOrder(sortOrder);
    }
    
    public boolean getSortOrderHasBeenModified() {
        return _value.getSortOrderHasBeenModified();
    }
    
    @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();
    }
    
}