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

/**
 * TrainingClassDetail.java
 */

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

import com.echothree.model.data.training.common.pk.TrainingClassDetailPK;

import com.echothree.model.data.training.common.pk.TrainingClassPK;
import com.echothree.model.data.workeffort.common.pk.WorkEffortScopePK;

import com.echothree.model.data.training.server.entity.TrainingClass;
import com.echothree.model.data.workeffort.server.entity.WorkEffortScope;

import com.echothree.model.data.training.server.factory.TrainingClassFactory;
import com.echothree.model.data.workeffort.server.factory.WorkEffortScopeFactory;

import com.echothree.model.data.training.common.pk.TrainingClassDetailPK;

import com.echothree.model.data.training.server.value.TrainingClassDetailValue;

import com.echothree.model.data.training.server.factory.TrainingClassDetailFactory;

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 TrainingClassDetail
        extends BaseEntity
        implements Serializable {
    
    private TrainingClassDetailPK _pk;
    private TrainingClassDetailValue _value;
    
    /** Creates a new instance of TrainingClassDetail */
    public TrainingClassDetail()
            throws PersistenceException {
        super();
    }
    
    /** Creates a new instance of TrainingClassDetail */
    public TrainingClassDetail(TrainingClassDetailValue value, EntityPermission entityPermission) {
        super(entityPermission);
        
        _value = value;
        _pk = value.getPrimaryKey();
    }
    
    @Override
    @Nonnull
    public TrainingClassDetailFactory getBaseFactoryInstance() {
        return TrainingClassDetailFactory.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 TrainingClassDetail that) {
            TrainingClassDetailValue thatValue = that.getTrainingClassDetailValue();
            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 TrainingClassDetailValue getTrainingClassDetailValue() {
        return _value;
    }
    
    public void setTrainingClassDetailValue(@Nonnull TrainingClassDetailValue value)
            throws PersistenceReadOnlyException {
        checkReadWrite();
        _value = value;
    }
    
    @Override
    @Nonnull
    public TrainingClassDetailPK getPrimaryKey() {
        return _pk;
    }
    
    @Nonnull
    public TrainingClassPK getTrainingClassPK() {
        return _value.getTrainingClassPK();
    }
    
    @Nonnull
    public TrainingClass getTrainingClass(EntityPermission entityPermission) {
        return TrainingClassFactory.getInstance().getEntityFromPK(entityPermission, getTrainingClassPK());
    }
    
    @Nonnull
    public TrainingClass getTrainingClass() {
        return getTrainingClass(EntityPermission.READ_ONLY);
    }
    
    @Nonnull
    public TrainingClass getTrainingClassForUpdate() {
        return getTrainingClass(EntityPermission.READ_WRITE);
    }
    
    public void setTrainingClassPK(@Nonnull TrainingClassPK trainingClassPK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setTrainingClassPK(trainingClassPK);
    }
    
    public void setTrainingClass(@Nonnull TrainingClass entity) {
        setTrainingClassPK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getTrainingClassPKHasBeenModified() {
        return _value.getTrainingClassPKHasBeenModified();
    }
    
    @Nonnull
    public String getTrainingClassName() {
        return _value.getTrainingClassName();
    }
    
    public void setTrainingClassName(@Nonnull String trainingClassName)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setTrainingClassName(trainingClassName);
    }
    
    public boolean getTrainingClassNameHasBeenModified() {
        return _value.getTrainingClassNameHasBeenModified();
    }
    
    @Nullable
    public Long getEstimatedReadingTime() {
        return _value.getEstimatedReadingTime();
    }
    
    public void setEstimatedReadingTime(@Nullable Long estimatedReadingTime)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setEstimatedReadingTime(estimatedReadingTime);
    }
    
    public boolean getEstimatedReadingTimeHasBeenModified() {
        return _value.getEstimatedReadingTimeHasBeenModified();
    }
    
    @Nullable
    public Long getReadingTimeAllowed() {
        return _value.getReadingTimeAllowed();
    }
    
    public void setReadingTimeAllowed(@Nullable Long readingTimeAllowed)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setReadingTimeAllowed(readingTimeAllowed);
    }
    
    public boolean getReadingTimeAllowedHasBeenModified() {
        return _value.getReadingTimeAllowedHasBeenModified();
    }
    
    @Nullable
    public Long getEstimatedTestingTime() {
        return _value.getEstimatedTestingTime();
    }
    
    public void setEstimatedTestingTime(@Nullable Long estimatedTestingTime)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setEstimatedTestingTime(estimatedTestingTime);
    }
    
    public boolean getEstimatedTestingTimeHasBeenModified() {
        return _value.getEstimatedTestingTimeHasBeenModified();
    }
    
    @Nullable
    public Long getTestingTimeAllowed() {
        return _value.getTestingTimeAllowed();
    }
    
    public void setTestingTimeAllowed(@Nullable Long testingTimeAllowed)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setTestingTimeAllowed(testingTimeAllowed);
    }
    
    public boolean getTestingTimeAllowedHasBeenModified() {
        return _value.getTestingTimeAllowedHasBeenModified();
    }
    
    @Nullable
    public Long getRequiredCompletionTime() {
        return _value.getRequiredCompletionTime();
    }
    
    public void setRequiredCompletionTime(@Nullable Long requiredCompletionTime)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setRequiredCompletionTime(requiredCompletionTime);
    }
    
    public boolean getRequiredCompletionTimeHasBeenModified() {
        return _value.getRequiredCompletionTimeHasBeenModified();
    }
    
    @Nullable
    public WorkEffortScopePK getWorkEffortScopePK() {
        return _value.getWorkEffortScopePK();
    }
    
    @Nullable
    public WorkEffortScope getWorkEffortScope(EntityPermission entityPermission) {
        WorkEffortScopePK pk = getWorkEffortScopePK();
        WorkEffortScope entity = pk == null? null: WorkEffortScopeFactory.getInstance().getEntityFromPK(entityPermission, pk);
        
        return entity;
    }
    
    @Nullable
    public WorkEffortScope getWorkEffortScope() {
        return getWorkEffortScope(EntityPermission.READ_ONLY);
    }
    
    @Nullable
    public WorkEffortScope getWorkEffortScopeForUpdate() {
        return getWorkEffortScope(EntityPermission.READ_WRITE);
    }
    
    public void setWorkEffortScopePK(@Nullable WorkEffortScopePK workEffortScopePK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setWorkEffortScopePK(workEffortScopePK);
    }
    
    public void setWorkEffortScope(@Nullable WorkEffortScope entity) {
        setWorkEffortScopePK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getWorkEffortScopePKHasBeenModified() {
        return _value.getWorkEffortScopePKHasBeenModified();
    }
    
    @Nullable
    public Integer getDefaultPercentageToPass() {
        return _value.getDefaultPercentageToPass();
    }
    
    public void setDefaultPercentageToPass(@Nullable Integer defaultPercentageToPass)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setDefaultPercentageToPass(defaultPercentageToPass);
    }
    
    public boolean getDefaultPercentageToPassHasBeenModified() {
        return _value.getDefaultPercentageToPassHasBeenModified();
    }
    
    @Nullable
    public Integer getOverallQuestionCount() {
        return _value.getOverallQuestionCount();
    }
    
    public void setOverallQuestionCount(@Nullable Integer overallQuestionCount)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setOverallQuestionCount(overallQuestionCount);
    }
    
    public boolean getOverallQuestionCountHasBeenModified() {
        return _value.getOverallQuestionCountHasBeenModified();
    }
    
    @Nullable
    public Long getTestingValidityTime() {
        return _value.getTestingValidityTime();
    }
    
    public void setTestingValidityTime(@Nullable Long testingValidityTime)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setTestingValidityTime(testingValidityTime);
    }
    
    public boolean getTestingValidityTimeHasBeenModified() {
        return _value.getTestingValidityTimeHasBeenModified();
    }
    
    @Nullable
    public Long getExpiredRetentionTime() {
        return _value.getExpiredRetentionTime();
    }
    
    public void setExpiredRetentionTime(@Nullable Long expiredRetentionTime)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setExpiredRetentionTime(expiredRetentionTime);
    }
    
    public boolean getExpiredRetentionTimeHasBeenModified() {
        return _value.getExpiredRetentionTimeHasBeenModified();
    }
    
    @Nonnull
    public Boolean getAlwaysReassignOnExpiration() {
        return _value.getAlwaysReassignOnExpiration();
    }
    
    public void setAlwaysReassignOnExpiration(@Nonnull Boolean alwaysReassignOnExpiration)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setAlwaysReassignOnExpiration(alwaysReassignOnExpiration);
    }
    
    public boolean getAlwaysReassignOnExpirationHasBeenModified() {
        return _value.getAlwaysReassignOnExpirationHasBeenModified();
    }
    
    @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();
    }
    
}