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

/**
 * UseDetail.java
 */

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

import com.echothree.model.data.offer.common.pk.UseDetailPK;

import com.echothree.model.data.offer.common.pk.UsePK;
import com.echothree.model.data.offer.common.pk.UseTypePK;

import com.echothree.model.data.offer.server.entity.Use;
import com.echothree.model.data.offer.server.entity.UseType;

import com.echothree.model.data.offer.server.factory.UseFactory;
import com.echothree.model.data.offer.server.factory.UseTypeFactory;

import com.echothree.model.data.offer.common.pk.UseDetailPK;

import com.echothree.model.data.offer.server.value.UseDetailValue;

import com.echothree.model.data.offer.server.factory.UseDetailFactory;

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 UseDetail
        extends BaseEntity
        implements Serializable {
    
    private UseDetailPK _pk;
    private UseDetailValue _value;
    
    /** Creates a new instance of UseDetail */
    public UseDetail()
            throws PersistenceException {
        super();
    }
    
    /** Creates a new instance of UseDetail */
    public UseDetail(UseDetailValue value, EntityPermission entityPermission) {
        super(entityPermission);
        
        _value = value;
        _pk = value.getPrimaryKey();
    }
    
    @Override
    @Nonnull
    public UseDetailFactory getBaseFactoryInstance() {
        return UseDetailFactory.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 UseDetail that) {
            UseDetailValue thatValue = that.getUseDetailValue();
            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 UseDetailValue getUseDetailValue() {
        return _value;
    }
    
    public void setUseDetailValue(@Nonnull UseDetailValue value)
            throws PersistenceReadOnlyException {
        checkReadWrite();
        _value = value;
    }
    
    @Override
    @Nonnull
    public UseDetailPK getPrimaryKey() {
        return _pk;
    }
    
    @Nonnull
    public UsePK getUsePK() {
        return _value.getUsePK();
    }
    
    @Nonnull
    public Use getUse(EntityPermission entityPermission) {
        return UseFactory.getInstance().getEntityFromPK(entityPermission, getUsePK());
    }
    
    @Nonnull
    public Use getUse() {
        return getUse(EntityPermission.READ_ONLY);
    }
    
    @Nonnull
    public Use getUseForUpdate() {
        return getUse(EntityPermission.READ_WRITE);
    }
    
    public void setUsePK(@Nonnull UsePK usePK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setUsePK(usePK);
    }
    
    public void setUse(@Nonnull Use entity) {
        setUsePK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getUsePKHasBeenModified() {
        return _value.getUsePKHasBeenModified();
    }
    
    @Nonnull
    public String getUseName() {
        return _value.getUseName();
    }
    
    public void setUseName(@Nonnull String useName)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setUseName(useName);
    }
    
    public boolean getUseNameHasBeenModified() {
        return _value.getUseNameHasBeenModified();
    }
    
    @Nonnull
    public UseTypePK getUseTypePK() {
        return _value.getUseTypePK();
    }
    
    @Nonnull
    public UseType getUseType(EntityPermission entityPermission) {
        return UseTypeFactory.getInstance().getEntityFromPK(entityPermission, getUseTypePK());
    }
    
    @Nonnull
    public UseType getUseType() {
        return getUseType(EntityPermission.READ_ONLY);
    }
    
    @Nonnull
    public UseType getUseTypeForUpdate() {
        return getUseType(EntityPermission.READ_WRITE);
    }
    
    public void setUseTypePK(@Nonnull UseTypePK useTypePK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setUseTypePK(useTypePK);
    }
    
    public void setUseType(@Nonnull UseType entity) {
        setUseTypePK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getUseTypePKHasBeenModified() {
        return _value.getUseTypePKHasBeenModified();
    }
    
    @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();
    }
    
}