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

/**
 * ChainDetail.java
 */

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

import com.echothree.model.data.chain.common.pk.ChainDetailPK;

import com.echothree.model.data.chain.common.pk.ChainPK;
import com.echothree.model.data.chain.common.pk.ChainTypePK;
import com.echothree.model.data.sequence.common.pk.SequencePK;

import com.echothree.model.data.chain.server.entity.Chain;
import com.echothree.model.data.chain.server.entity.ChainType;
import com.echothree.model.data.sequence.server.entity.Sequence;

import com.echothree.model.data.chain.server.factory.ChainFactory;
import com.echothree.model.data.chain.server.factory.ChainTypeFactory;
import com.echothree.model.data.sequence.server.factory.SequenceFactory;

import com.echothree.model.data.chain.common.pk.ChainDetailPK;

import com.echothree.model.data.chain.server.value.ChainDetailValue;

import com.echothree.model.data.chain.server.factory.ChainDetailFactory;

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;

public class ChainDetail
        extends BaseEntity
        implements Serializable {
    
    private ChainDetailPK _pk;
    private ChainDetailValue _value;
    
    /** Creates a new instance of ChainDetail */
    public ChainDetail()
            throws PersistenceException {
        super();
    }
    
    /** Creates a new instance of ChainDetail */
    public ChainDetail(ChainDetailValue value, EntityPermission entityPermission) {
        super(entityPermission);
        
        _value = value;
        _pk = value.getPrimaryKey();
    }
    
    @Override
    public ChainDetailFactory getBaseFactoryInstance() {
        return ChainDetailFactory.getInstance();
    }
    
    @Override
    public boolean hasBeenModified() {
        return _value.hasBeenModified();
    }
    
    @Override
    public int hashCode() {
        return _pk.hashCode();
    }
    
    @Override
    public String toString() {
        return _pk.toString();
    }
    
    @Override
    public boolean equals(Object other) {
        if(this == other)
            return true;
        
        if(other instanceof ChainDetail that) {
            ChainDetailValue thatValue = that.getChainDetailValue();
            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);
    }
    
    public ChainDetailValue getChainDetailValue() {
        return _value;
    }
    
    public void setChainDetailValue(ChainDetailValue value)
            throws PersistenceReadOnlyException {
        checkReadWrite();
        _value = value;
    }
    
    @Override
    public ChainDetailPK getPrimaryKey() {
        return _pk;
    }
    
    public ChainPK getChainPK() {
        return _value.getChainPK();
    }
    
    public Chain getChain(EntityPermission entityPermission) {
        return ChainFactory.getInstance().getEntityFromPK(entityPermission, getChainPK());
    }
    
    public Chain getChain() {
        return getChain(EntityPermission.READ_ONLY);
    }
    
    public Chain getChainForUpdate() {
        return getChain(EntityPermission.READ_WRITE);
    }
    
    public void setChainPK(ChainPK chainPK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setChainPK(chainPK);
    }
    
    public void setChain(Chain entity) {
        setChainPK(entity == null? null: entity.getPrimaryKey());
    }
    
    public boolean getChainPKHasBeenModified() {
        return _value.getChainPKHasBeenModified();
    }
    
    public ChainTypePK getChainTypePK() {
        return _value.getChainTypePK();
    }
    
    public ChainType getChainType(EntityPermission entityPermission) {
        return ChainTypeFactory.getInstance().getEntityFromPK(entityPermission, getChainTypePK());
    }
    
    public ChainType getChainType() {
        return getChainType(EntityPermission.READ_ONLY);
    }
    
    public ChainType getChainTypeForUpdate() {
        return getChainType(EntityPermission.READ_WRITE);
    }
    
    public void setChainTypePK(ChainTypePK chainTypePK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setChainTypePK(chainTypePK);
    }
    
    public void setChainType(ChainType entity) {
        setChainTypePK(entity == null? null: entity.getPrimaryKey());
    }
    
    public boolean getChainTypePKHasBeenModified() {
        return _value.getChainTypePKHasBeenModified();
    }
    
    public String getChainName() {
        return _value.getChainName();
    }
    
    public void setChainName(String chainName)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setChainName(chainName);
    }
    
    public boolean getChainNameHasBeenModified() {
        return _value.getChainNameHasBeenModified();
    }
    
    public SequencePK getChainInstanceSequencePK() {
        return _value.getChainInstanceSequencePK();
    }
    
    public Sequence getChainInstanceSequence(EntityPermission entityPermission) {
        SequencePK pk = getChainInstanceSequencePK();
        Sequence entity = pk == null? null: SequenceFactory.getInstance().getEntityFromPK(entityPermission, pk);
        
        return entity;
    }
    
    public Sequence getChainInstanceSequence() {
        return getChainInstanceSequence(EntityPermission.READ_ONLY);
    }
    
    public Sequence getChainInstanceSequenceForUpdate() {
        return getChainInstanceSequence(EntityPermission.READ_WRITE);
    }
    
    public void setChainInstanceSequencePK(SequencePK chainInstanceSequencePK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setChainInstanceSequencePK(chainInstanceSequencePK);
    }
    
    public void setChainInstanceSequence(Sequence entity) {
        setChainInstanceSequencePK(entity == null? null: entity.getPrimaryKey());
    }
    
    public boolean getChainInstanceSequencePKHasBeenModified() {
        return _value.getChainInstanceSequencePKHasBeenModified();
    }
    
    public Boolean getIsDefault() {
        return _value.getIsDefault();
    }
    
    public void setIsDefault(Boolean isDefault)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setIsDefault(isDefault);
    }
    
    public boolean getIsDefaultHasBeenModified() {
        return _value.getIsDefaultHasBeenModified();
    }
    
    public Integer getSortOrder() {
        return _value.getSortOrder();
    }
    
    public void setSortOrder(Integer sortOrder)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setSortOrder(sortOrder);
    }
    
    public boolean getSortOrderHasBeenModified() {
        return _value.getSortOrderHasBeenModified();
    }
    
    public Long getFromTime() {
        return _value.getFromTime();
    }
    
    public void setFromTime(Long fromTime)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setFromTime(fromTime);
    }
    
    public boolean getFromTimeHasBeenModified() {
        return _value.getFromTimeHasBeenModified();
    }
    
    public Long getThruTime() {
        return _value.getThruTime();
    }
    
    public void setThruTime(Long thruTime)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setThruTime(thruTime);
    }
    
    public boolean getThruTimeHasBeenModified() {
        return _value.getThruTimeHasBeenModified();
    }
    
}