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

/**
 * ItemCategoryDetail.java
 */

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

import com.echothree.model.data.item.common.pk.ItemCategoryDetailPK;

import com.echothree.model.data.item.common.pk.ItemCategoryPK;
import com.echothree.model.data.sequence.common.pk.SequencePK;

import com.echothree.model.data.item.server.entity.ItemCategory;
import com.echothree.model.data.sequence.server.entity.Sequence;

import com.echothree.model.data.item.server.factory.ItemCategoryFactory;
import com.echothree.model.data.sequence.server.factory.SequenceFactory;

import com.echothree.model.data.item.common.pk.ItemCategoryDetailPK;

import com.echothree.model.data.item.server.value.ItemCategoryDetailValue;

import com.echothree.model.data.item.server.factory.ItemCategoryDetailFactory;

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 ItemCategoryDetail
        extends BaseEntity
        implements Serializable {
    
    private ItemCategoryDetailPK _pk;
    private ItemCategoryDetailValue _value;
    
    /** Creates a new instance of ItemCategoryDetail */
    public ItemCategoryDetail()
            throws PersistenceException {
        super();
    }
    
    /** Creates a new instance of ItemCategoryDetail */
    public ItemCategoryDetail(ItemCategoryDetailValue value, EntityPermission entityPermission) {
        super(entityPermission);
        
        _value = value;
        _pk = value.getPrimaryKey();
    }
    
    @Override
    @Nonnull
    public ItemCategoryDetailFactory getBaseFactoryInstance() {
        return ItemCategoryDetailFactory.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 ItemCategoryDetail that) {
            ItemCategoryDetailValue thatValue = that.getItemCategoryDetailValue();
            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 ItemCategoryDetailValue getItemCategoryDetailValue() {
        return _value;
    }
    
    public void setItemCategoryDetailValue(@Nonnull ItemCategoryDetailValue value)
            throws PersistenceReadOnlyException {
        checkReadWrite();
        _value = value;
    }
    
    @Override
    @Nonnull
    public ItemCategoryDetailPK getPrimaryKey() {
        return _pk;
    }
    
    @Nonnull
    public ItemCategoryPK getItemCategoryPK() {
        return _value.getItemCategoryPK();
    }
    
    @Nonnull
    public ItemCategory getItemCategory(EntityPermission entityPermission) {
        return ItemCategoryFactory.getInstance().getEntityFromPK(entityPermission, getItemCategoryPK());
    }
    
    @Nonnull
    public ItemCategory getItemCategory() {
        return getItemCategory(EntityPermission.READ_ONLY);
    }
    
    @Nonnull
    public ItemCategory getItemCategoryForUpdate() {
        return getItemCategory(EntityPermission.READ_WRITE);
    }
    
    public void setItemCategoryPK(@Nonnull ItemCategoryPK itemCategoryPK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setItemCategoryPK(itemCategoryPK);
    }
    
    public void setItemCategory(@Nonnull ItemCategory entity) {
        setItemCategoryPK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getItemCategoryPKHasBeenModified() {
        return _value.getItemCategoryPKHasBeenModified();
    }
    
    @Nonnull
    public String getItemCategoryName() {
        return _value.getItemCategoryName();
    }
    
    public void setItemCategoryName(@Nonnull String itemCategoryName)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setItemCategoryName(itemCategoryName);
    }
    
    public boolean getItemCategoryNameHasBeenModified() {
        return _value.getItemCategoryNameHasBeenModified();
    }
    
    @Nullable
    public ItemCategoryPK getParentItemCategoryPK() {
        return _value.getParentItemCategoryPK();
    }
    
    @Nullable
    public ItemCategory getParentItemCategory(EntityPermission entityPermission) {
        ItemCategoryPK pk = getParentItemCategoryPK();
        ItemCategory entity = pk == null? null: ItemCategoryFactory.getInstance().getEntityFromPK(entityPermission, pk);
        
        return entity;
    }
    
    @Nullable
    public ItemCategory getParentItemCategory() {
        return getParentItemCategory(EntityPermission.READ_ONLY);
    }
    
    @Nullable
    public ItemCategory getParentItemCategoryForUpdate() {
        return getParentItemCategory(EntityPermission.READ_WRITE);
    }
    
    public void setParentItemCategoryPK(@Nullable ItemCategoryPK parentItemCategoryPK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setParentItemCategoryPK(parentItemCategoryPK);
    }
    
    public void setParentItemCategory(@Nullable ItemCategory entity) {
        setParentItemCategoryPK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getParentItemCategoryPKHasBeenModified() {
        return _value.getParentItemCategoryPKHasBeenModified();
    }
    
    @Nullable
    public SequencePK getItemSequencePK() {
        return _value.getItemSequencePK();
    }
    
    @Nullable
    public Sequence getItemSequence(EntityPermission entityPermission) {
        SequencePK pk = getItemSequencePK();
        Sequence entity = pk == null? null: SequenceFactory.getInstance().getEntityFromPK(entityPermission, pk);
        
        return entity;
    }
    
    @Nullable
    public Sequence getItemSequence() {
        return getItemSequence(EntityPermission.READ_ONLY);
    }
    
    @Nullable
    public Sequence getItemSequenceForUpdate() {
        return getItemSequence(EntityPermission.READ_WRITE);
    }
    
    public void setItemSequencePK(@Nullable SequencePK itemSequencePK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setItemSequencePK(itemSequencePK);
    }
    
    public void setItemSequence(@Nullable Sequence entity) {
        setItemSequencePK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getItemSequencePKHasBeenModified() {
        return _value.getItemSequencePKHasBeenModified();
    }
    
    @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();
    }
    
}