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

/**
 * WorkRequirementScopeDetail.java
 */

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

import com.echothree.model.data.workrequirement.common.pk.WorkRequirementScopeDetailPK;

import com.echothree.model.data.workrequirement.common.pk.WorkRequirementScopePK;
import com.echothree.model.data.workeffort.common.pk.WorkEffortScopePK;
import com.echothree.model.data.workrequirement.common.pk.WorkRequirementTypePK;
import com.echothree.model.data.sequence.common.pk.SequencePK;
import com.echothree.model.data.selector.common.pk.SelectorPK;

import com.echothree.model.data.workrequirement.server.entity.WorkRequirementScope;
import com.echothree.model.data.workeffort.server.entity.WorkEffortScope;
import com.echothree.model.data.workrequirement.server.entity.WorkRequirementType;
import com.echothree.model.data.sequence.server.entity.Sequence;
import com.echothree.model.data.selector.server.entity.Selector;

import com.echothree.model.data.workrequirement.server.factory.WorkRequirementScopeFactory;
import com.echothree.model.data.workeffort.server.factory.WorkEffortScopeFactory;
import com.echothree.model.data.workrequirement.server.factory.WorkRequirementTypeFactory;
import com.echothree.model.data.sequence.server.factory.SequenceFactory;
import com.echothree.model.data.selector.server.factory.SelectorFactory;

import com.echothree.model.data.workrequirement.common.pk.WorkRequirementScopeDetailPK;

import com.echothree.model.data.workrequirement.server.value.WorkRequirementScopeDetailValue;

import com.echothree.model.data.workrequirement.server.factory.WorkRequirementScopeDetailFactory;

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 WorkRequirementScopeDetail
        extends BaseEntity
        implements Serializable {
    
    private WorkRequirementScopeDetailPK _pk;
    private WorkRequirementScopeDetailValue _value;
    
    /** Creates a new instance of WorkRequirementScopeDetail */
    public WorkRequirementScopeDetail()
            throws PersistenceException {
        super();
    }
    
    /** Creates a new instance of WorkRequirementScopeDetail */
    public WorkRequirementScopeDetail(WorkRequirementScopeDetailValue value, EntityPermission entityPermission) {
        super(entityPermission);
        
        _value = value;
        _pk = value.getPrimaryKey();
    }
    
    @Override
    @Nonnull
    public WorkRequirementScopeDetailFactory getBaseFactoryInstance() {
        return WorkRequirementScopeDetailFactory.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 WorkRequirementScopeDetail that) {
            WorkRequirementScopeDetailValue thatValue = that.getWorkRequirementScopeDetailValue();
            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 WorkRequirementScopeDetailValue getWorkRequirementScopeDetailValue() {
        return _value;
    }
    
    public void setWorkRequirementScopeDetailValue(@Nonnull WorkRequirementScopeDetailValue value)
            throws PersistenceReadOnlyException {
        checkReadWrite();
        _value = value;
    }
    
    @Override
    @Nonnull
    public WorkRequirementScopeDetailPK getPrimaryKey() {
        return _pk;
    }
    
    @Nonnull
    public WorkRequirementScopePK getWorkRequirementScopePK() {
        return _value.getWorkRequirementScopePK();
    }
    
    @Nonnull
    public WorkRequirementScope getWorkRequirementScope(EntityPermission entityPermission) {
        return WorkRequirementScopeFactory.getInstance().getEntityFromPK(entityPermission, getWorkRequirementScopePK());
    }
    
    @Nonnull
    public WorkRequirementScope getWorkRequirementScope() {
        return getWorkRequirementScope(EntityPermission.READ_ONLY);
    }
    
    @Nonnull
    public WorkRequirementScope getWorkRequirementScopeForUpdate() {
        return getWorkRequirementScope(EntityPermission.READ_WRITE);
    }
    
    public void setWorkRequirementScopePK(@Nonnull WorkRequirementScopePK workRequirementScopePK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setWorkRequirementScopePK(workRequirementScopePK);
    }
    
    public void setWorkRequirementScope(@Nonnull WorkRequirementScope entity) {
        setWorkRequirementScopePK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getWorkRequirementScopePKHasBeenModified() {
        return _value.getWorkRequirementScopePKHasBeenModified();
    }
    
    @Nonnull
    public WorkEffortScopePK getWorkEffortScopePK() {
        return _value.getWorkEffortScopePK();
    }
    
    @Nonnull
    public WorkEffortScope getWorkEffortScope(EntityPermission entityPermission) {
        return WorkEffortScopeFactory.getInstance().getEntityFromPK(entityPermission, getWorkEffortScopePK());
    }
    
    @Nonnull
    public WorkEffortScope getWorkEffortScope() {
        return getWorkEffortScope(EntityPermission.READ_ONLY);
    }
    
    @Nonnull
    public WorkEffortScope getWorkEffortScopeForUpdate() {
        return getWorkEffortScope(EntityPermission.READ_WRITE);
    }
    
    public void setWorkEffortScopePK(@Nonnull WorkEffortScopePK workEffortScopePK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setWorkEffortScopePK(workEffortScopePK);
    }
    
    public void setWorkEffortScope(@Nonnull WorkEffortScope entity) {
        setWorkEffortScopePK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getWorkEffortScopePKHasBeenModified() {
        return _value.getWorkEffortScopePKHasBeenModified();
    }
    
    @Nonnull
    public WorkRequirementTypePK getWorkRequirementTypePK() {
        return _value.getWorkRequirementTypePK();
    }
    
    @Nonnull
    public WorkRequirementType getWorkRequirementType(EntityPermission entityPermission) {
        return WorkRequirementTypeFactory.getInstance().getEntityFromPK(entityPermission, getWorkRequirementTypePK());
    }
    
    @Nonnull
    public WorkRequirementType getWorkRequirementType() {
        return getWorkRequirementType(EntityPermission.READ_ONLY);
    }
    
    @Nonnull
    public WorkRequirementType getWorkRequirementTypeForUpdate() {
        return getWorkRequirementType(EntityPermission.READ_WRITE);
    }
    
    public void setWorkRequirementTypePK(@Nonnull WorkRequirementTypePK workRequirementTypePK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setWorkRequirementTypePK(workRequirementTypePK);
    }
    
    public void setWorkRequirementType(@Nonnull WorkRequirementType entity) {
        setWorkRequirementTypePK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getWorkRequirementTypePKHasBeenModified() {
        return _value.getWorkRequirementTypePKHasBeenModified();
    }
    
    @Nullable
    public SequencePK getWorkRequirementSequencePK() {
        return _value.getWorkRequirementSequencePK();
    }
    
    @Nullable
    public Sequence getWorkRequirementSequence(EntityPermission entityPermission) {
        SequencePK pk = getWorkRequirementSequencePK();
        Sequence entity = pk == null? null: SequenceFactory.getInstance().getEntityFromPK(entityPermission, pk);
        
        return entity;
    }
    
    @Nullable
    public Sequence getWorkRequirementSequence() {
        return getWorkRequirementSequence(EntityPermission.READ_ONLY);
    }
    
    @Nullable
    public Sequence getWorkRequirementSequenceForUpdate() {
        return getWorkRequirementSequence(EntityPermission.READ_WRITE);
    }
    
    public void setWorkRequirementSequencePK(@Nullable SequencePK workRequirementSequencePK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setWorkRequirementSequencePK(workRequirementSequencePK);
    }
    
    public void setWorkRequirementSequence(@Nullable Sequence entity) {
        setWorkRequirementSequencePK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getWorkRequirementSequencePKHasBeenModified() {
        return _value.getWorkRequirementSequencePKHasBeenModified();
    }
    
    @Nullable
    public SequencePK getWorkTimeSequencePK() {
        return _value.getWorkTimeSequencePK();
    }
    
    @Nullable
    public Sequence getWorkTimeSequence(EntityPermission entityPermission) {
        SequencePK pk = getWorkTimeSequencePK();
        Sequence entity = pk == null? null: SequenceFactory.getInstance().getEntityFromPK(entityPermission, pk);
        
        return entity;
    }
    
    @Nullable
    public Sequence getWorkTimeSequence() {
        return getWorkTimeSequence(EntityPermission.READ_ONLY);
    }
    
    @Nullable
    public Sequence getWorkTimeSequenceForUpdate() {
        return getWorkTimeSequence(EntityPermission.READ_WRITE);
    }
    
    public void setWorkTimeSequencePK(@Nullable SequencePK workTimeSequencePK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setWorkTimeSequencePK(workTimeSequencePK);
    }
    
    public void setWorkTimeSequence(@Nullable Sequence entity) {
        setWorkTimeSequencePK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getWorkTimeSequencePKHasBeenModified() {
        return _value.getWorkTimeSequencePKHasBeenModified();
    }
    
    @Nullable
    public SelectorPK getWorkAssignmentSelectorPK() {
        return _value.getWorkAssignmentSelectorPK();
    }
    
    @Nullable
    public Selector getWorkAssignmentSelector(EntityPermission entityPermission) {
        SelectorPK pk = getWorkAssignmentSelectorPK();
        Selector entity = pk == null? null: SelectorFactory.getInstance().getEntityFromPK(entityPermission, pk);
        
        return entity;
    }
    
    @Nullable
    public Selector getWorkAssignmentSelector() {
        return getWorkAssignmentSelector(EntityPermission.READ_ONLY);
    }
    
    @Nullable
    public Selector getWorkAssignmentSelectorForUpdate() {
        return getWorkAssignmentSelector(EntityPermission.READ_WRITE);
    }
    
    public void setWorkAssignmentSelectorPK(@Nullable SelectorPK workAssignmentSelectorPK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setWorkAssignmentSelectorPK(workAssignmentSelectorPK);
    }
    
    public void setWorkAssignmentSelector(@Nullable Selector entity) {
        setWorkAssignmentSelectorPK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getWorkAssignmentSelectorPKHasBeenModified() {
        return _value.getWorkAssignmentSelectorPKHasBeenModified();
    }
    
    @Nullable
    public Long getEstimatedTimeAllowed() {
        return _value.getEstimatedTimeAllowed();
    }
    
    public void setEstimatedTimeAllowed(@Nullable Long estimatedTimeAllowed)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setEstimatedTimeAllowed(estimatedTimeAllowed);
    }
    
    public boolean getEstimatedTimeAllowedHasBeenModified() {
        return _value.getEstimatedTimeAllowedHasBeenModified();
    }
    
    @Nullable
    public Long getMaximumTimeAllowed() {
        return _value.getMaximumTimeAllowed();
    }
    
    public void setMaximumTimeAllowed(@Nullable Long maximumTimeAllowed)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setMaximumTimeAllowed(maximumTimeAllowed);
    }
    
    public boolean getMaximumTimeAllowedHasBeenModified() {
        return _value.getMaximumTimeAllowedHasBeenModified();
    }
    
    @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();
    }
    
}