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

/**
 * PeriodKindDetail.java
 */

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

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

import com.echothree.model.data.period.common.pk.PeriodKindPK;
import com.echothree.model.data.workflow.common.pk.WorkflowEntrancePK;

import com.echothree.model.data.period.server.entity.PeriodKind;
import com.echothree.model.data.workflow.server.entity.WorkflowEntrance;

import com.echothree.model.data.period.server.factory.PeriodKindFactory;
import com.echothree.model.data.workflow.server.factory.WorkflowEntranceFactory;

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

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

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

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 PeriodKindDetail
        extends BaseEntity
        implements Serializable {
    
    private PeriodKindDetailPK _pk;
    private PeriodKindDetailValue _value;
    
    /** Creates a new instance of PeriodKindDetail */
    public PeriodKindDetail()
            throws PersistenceException {
        super();
    }
    
    /** Creates a new instance of PeriodKindDetail */
    public PeriodKindDetail(PeriodKindDetailValue value, EntityPermission entityPermission) {
        super(entityPermission);
        
        _value = value;
        _pk = value.getPrimaryKey();
    }
    
    @Override
    @Nonnull
    public PeriodKindDetailFactory getBaseFactoryInstance() {
        return PeriodKindDetailFactory.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 PeriodKindDetail that) {
            PeriodKindDetailValue thatValue = that.getPeriodKindDetailValue();
            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 PeriodKindDetailValue getPeriodKindDetailValue() {
        return _value;
    }
    
    public void setPeriodKindDetailValue(@Nonnull PeriodKindDetailValue value)
            throws PersistenceReadOnlyException {
        checkReadWrite();
        _value = value;
    }
    
    @Override
    @Nonnull
    public PeriodKindDetailPK getPrimaryKey() {
        return _pk;
    }
    
    @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 getPeriodKindName() {
        return _value.getPeriodKindName();
    }
    
    public void setPeriodKindName(@Nonnull String periodKindName)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setPeriodKindName(periodKindName);
    }
    
    public boolean getPeriodKindNameHasBeenModified() {
        return _value.getPeriodKindNameHasBeenModified();
    }
    
    @Nullable
    public WorkflowEntrancePK getWorkflowEntrancePK() {
        return _value.getWorkflowEntrancePK();
    }
    
    @Nullable
    public WorkflowEntrance getWorkflowEntrance(EntityPermission entityPermission) {
        WorkflowEntrancePK pk = getWorkflowEntrancePK();
        WorkflowEntrance entity = pk == null? null: WorkflowEntranceFactory.getInstance().getEntityFromPK(entityPermission, pk);
        
        return entity;
    }
    
    @Nullable
    public WorkflowEntrance getWorkflowEntrance() {
        return getWorkflowEntrance(EntityPermission.READ_ONLY);
    }
    
    @Nullable
    public WorkflowEntrance getWorkflowEntranceForUpdate() {
        return getWorkflowEntrance(EntityPermission.READ_WRITE);
    }
    
    public void setWorkflowEntrancePK(@Nullable WorkflowEntrancePK workflowEntrancePK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setWorkflowEntrancePK(workflowEntrancePK);
    }
    
    public void setWorkflowEntrance(@Nullable WorkflowEntrance entity) {
        setWorkflowEntrancePK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getWorkflowEntrancePKHasBeenModified() {
        return _value.getWorkflowEntrancePKHasBeenModified();
    }
    
    @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();
    }
    
}