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

/**
 * SurveyDetail.java
 */

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

import com.echothree.model.data.survey.common.pk.SurveyDetailPK;

import com.echothree.model.data.survey.common.pk.SurveyPK;
import com.echothree.model.data.survey.common.pk.SurveyTypePK;

import com.echothree.model.data.survey.server.entity.Survey;
import com.echothree.model.data.survey.server.entity.SurveyType;

import com.echothree.model.data.survey.server.factory.SurveyFactory;
import com.echothree.model.data.survey.server.factory.SurveyTypeFactory;

import com.echothree.model.data.survey.common.pk.SurveyDetailPK;

import com.echothree.model.data.survey.server.value.SurveyDetailValue;

import com.echothree.model.data.survey.server.factory.SurveyDetailFactory;

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 SurveyDetail
        extends BaseEntity
        implements Serializable {
    
    private SurveyDetailPK _pk;
    private SurveyDetailValue _value;
    
    /** Creates a new instance of SurveyDetail */
    public SurveyDetail()
            throws PersistenceException {
        super();
    }
    
    /** Creates a new instance of SurveyDetail */
    public SurveyDetail(SurveyDetailValue value, EntityPermission entityPermission) {
        super(entityPermission);
        
        _value = value;
        _pk = value.getPrimaryKey();
    }
    
    @Override
    @Nonnull
    public SurveyDetailFactory getBaseFactoryInstance() {
        return SurveyDetailFactory.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 SurveyDetail that) {
            SurveyDetailValue thatValue = that.getSurveyDetailValue();
            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 SurveyDetailValue getSurveyDetailValue() {
        return _value;
    }
    
    public void setSurveyDetailValue(@Nonnull SurveyDetailValue value)
            throws PersistenceReadOnlyException {
        checkReadWrite();
        _value = value;
    }
    
    @Override
    @Nonnull
    public SurveyDetailPK getPrimaryKey() {
        return _pk;
    }
    
    @Nonnull
    public SurveyPK getSurveyPK() {
        return _value.getSurveyPK();
    }
    
    @Nonnull
    public Survey getSurvey(EntityPermission entityPermission) {
        return SurveyFactory.getInstance().getEntityFromPK(entityPermission, getSurveyPK());
    }
    
    @Nonnull
    public Survey getSurvey() {
        return getSurvey(EntityPermission.READ_ONLY);
    }
    
    @Nonnull
    public Survey getSurveyForUpdate() {
        return getSurvey(EntityPermission.READ_WRITE);
    }
    
    public void setSurveyPK(@Nonnull SurveyPK surveyPK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setSurveyPK(surveyPK);
    }
    
    public void setSurvey(@Nonnull Survey entity) {
        setSurveyPK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getSurveyPKHasBeenModified() {
        return _value.getSurveyPKHasBeenModified();
    }
    
    @Nonnull
    public SurveyTypePK getSurveyTypePK() {
        return _value.getSurveyTypePK();
    }
    
    @Nonnull
    public SurveyType getSurveyType(EntityPermission entityPermission) {
        return SurveyTypeFactory.getInstance().getEntityFromPK(entityPermission, getSurveyTypePK());
    }
    
    @Nonnull
    public SurveyType getSurveyType() {
        return getSurveyType(EntityPermission.READ_ONLY);
    }
    
    @Nonnull
    public SurveyType getSurveyTypeForUpdate() {
        return getSurveyType(EntityPermission.READ_WRITE);
    }
    
    public void setSurveyTypePK(@Nonnull SurveyTypePK surveyTypePK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setSurveyTypePK(surveyTypePK);
    }
    
    public void setSurveyType(@Nonnull SurveyType entity) {
        setSurveyTypePK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getSurveyTypePKHasBeenModified() {
        return _value.getSurveyTypePKHasBeenModified();
    }
    
    @Nonnull
    public String getSurveyName() {
        return _value.getSurveyName();
    }
    
    public void setSurveyName(@Nonnull String surveyName)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setSurveyName(surveyName);
    }
    
    public boolean getSurveyNameHasBeenModified() {
        return _value.getSurveyNameHasBeenModified();
    }
    
    @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();
    }
    
}