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

/**
 * PeriodDetail.java
 */

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

import com.echothree.model.data.period.common.pk.PeriodDetailPK;

import com.echothree.model.data.period.common.pk.PeriodPK;
import com.echothree.model.data.period.common.pk.PeriodKindPK;
import com.echothree.model.data.period.common.pk.PeriodTypePK;

import com.echothree.model.data.period.server.entity.Period;
import com.echothree.model.data.period.server.entity.PeriodKind;
import com.echothree.model.data.period.server.entity.PeriodType;

import com.echothree.model.data.period.server.factory.PeriodFactory;
import com.echothree.model.data.period.server.factory.PeriodKindFactory;
import com.echothree.model.data.period.server.factory.PeriodTypeFactory;

import com.echothree.model.data.period.common.pk.PeriodDetailPK;

import com.echothree.model.data.period.server.value.PeriodDetailValue;

import com.echothree.model.data.period.server.factory.PeriodDetailFactory;

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 PeriodDetail
        extends BaseEntity
        implements Serializable {
    
    private PeriodDetailPK _pk;
    private PeriodDetailValue _value;
    
    /** Creates a new instance of PeriodDetail */
    public PeriodDetail()
            throws PersistenceException {
        super();
    }
    
    /** Creates a new instance of PeriodDetail */
    public PeriodDetail(PeriodDetailValue value, EntityPermission entityPermission) {
        super(entityPermission);
        
        _value = value;
        _pk = value.getPrimaryKey();
    }
    
    @Override
    @Nonnull
    public PeriodDetailFactory getBaseFactoryInstance() {
        return PeriodDetailFactory.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 PeriodDetail that) {
            PeriodDetailValue thatValue = that.getPeriodDetailValue();
            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 PeriodDetailValue getPeriodDetailValue() {
        return _value;
    }
    
    public void setPeriodDetailValue(@Nonnull PeriodDetailValue value)
            throws PersistenceReadOnlyException {
        checkReadWrite();
        _value = value;
    }
    
    @Override
    @Nonnull
    public PeriodDetailPK getPrimaryKey() {
        return _pk;
    }
    
    @Nonnull
    public PeriodPK getPeriodPK() {
        return _value.getPeriodPK();
    }
    
    @Nonnull
    public Period getPeriod(EntityPermission entityPermission) {
        return PeriodFactory.getInstance().getEntityFromPK(entityPermission, getPeriodPK());
    }
    
    @Nonnull
    public Period getPeriod() {
        return getPeriod(EntityPermission.READ_ONLY);
    }
    
    @Nonnull
    public Period getPeriodForUpdate() {
        return getPeriod(EntityPermission.READ_WRITE);
    }
    
    public void setPeriodPK(@Nonnull PeriodPK periodPK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setPeriodPK(periodPK);
    }
    
    public void setPeriod(@Nonnull Period entity) {
        setPeriodPK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getPeriodPKHasBeenModified() {
        return _value.getPeriodPKHasBeenModified();
    }
    
    @Nonnull
    public PeriodKindPK getPeriodKindPK() {
        return _value.getPeriodKindPK();
    }
    
    @Nonnull
    public PeriodKind getPeriodKind(EntityPermission entityPermission) {
        return PeriodKindFactory.getInstance().getEntityFromPK(entityPermission, getPeriodKindPK());
    }
    
    @Nonnull
    public PeriodKind getPeriodKind() {
        return getPeriodKind(EntityPermission.READ_ONLY);
    }
    
    @Nonnull
    public PeriodKind getPeriodKindForUpdate() {
        return getPeriodKind(EntityPermission.READ_WRITE);
    }
    
    public void setPeriodKindPK(@Nonnull PeriodKindPK periodKindPK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setPeriodKindPK(periodKindPK);
    }
    
    public void setPeriodKind(@Nonnull PeriodKind entity) {
        setPeriodKindPK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getPeriodKindPKHasBeenModified() {
        return _value.getPeriodKindPKHasBeenModified();
    }
    
    @Nonnull
    public String getPeriodName() {
        return _value.getPeriodName();
    }
    
    public void setPeriodName(@Nonnull String periodName)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setPeriodName(periodName);
    }
    
    public boolean getPeriodNameHasBeenModified() {
        return _value.getPeriodNameHasBeenModified();
    }
    
    @Nullable
    public PeriodPK getParentPeriodPK() {
        return _value.getParentPeriodPK();
    }
    
    @Nullable
    public Period getParentPeriod(EntityPermission entityPermission) {
        PeriodPK pk = getParentPeriodPK();
        Period entity = pk == null? null: PeriodFactory.getInstance().getEntityFromPK(entityPermission, pk);
        
        return entity;
    }
    
    @Nullable
    public Period getParentPeriod() {
        return getParentPeriod(EntityPermission.READ_ONLY);
    }
    
    @Nullable
    public Period getParentPeriodForUpdate() {
        return getParentPeriod(EntityPermission.READ_WRITE);
    }
    
    public void setParentPeriodPK(@Nullable PeriodPK parentPeriodPK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setParentPeriodPK(parentPeriodPK);
    }
    
    public void setParentPeriod(@Nullable Period entity) {
        setParentPeriodPK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getParentPeriodPKHasBeenModified() {
        return _value.getParentPeriodPKHasBeenModified();
    }
    
    @Nullable
    public PeriodTypePK getPeriodTypePK() {
        return _value.getPeriodTypePK();
    }
    
    @Nullable
    public PeriodType getPeriodType(EntityPermission entityPermission) {
        PeriodTypePK pk = getPeriodTypePK();
        PeriodType entity = pk == null? null: PeriodTypeFactory.getInstance().getEntityFromPK(entityPermission, pk);
        
        return entity;
    }
    
    @Nullable
    public PeriodType getPeriodType() {
        return getPeriodType(EntityPermission.READ_ONLY);
    }
    
    @Nullable
    public PeriodType getPeriodTypeForUpdate() {
        return getPeriodType(EntityPermission.READ_WRITE);
    }
    
    public void setPeriodTypePK(@Nullable PeriodTypePK periodTypePK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setPeriodTypePK(periodTypePK);
    }
    
    public void setPeriodType(@Nullable PeriodType entity) {
        setPeriodTypePK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getPeriodTypePKHasBeenModified() {
        return _value.getPeriodTypePKHasBeenModified();
    }
    
    @Nonnull
    public Long getStartTime() {
        return _value.getStartTime();
    }
    
    public void setStartTime(@Nonnull Long startTime)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setStartTime(startTime);
    }
    
    public boolean getStartTimeHasBeenModified() {
        return _value.getStartTimeHasBeenModified();
    }
    
    @Nonnull
    public Long getEndTime() {
        return _value.getEndTime();
    }
    
    public void setEndTime(@Nonnull Long endTime)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setEndTime(endTime);
    }
    
    public boolean getEndTimeHasBeenModified() {
        return _value.getEndTimeHasBeenModified();
    }
    
    @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();
    }
    
}