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

/**
 * CancellationKindDetail.java
 */

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

import com.echothree.model.data.cancellationpolicy.common.pk.CancellationKindDetailPK;

import com.echothree.model.data.cancellationpolicy.common.pk.CancellationKindPK;
import com.echothree.model.data.sequence.common.pk.SequenceTypePK;

import com.echothree.model.data.cancellationpolicy.server.entity.CancellationKind;
import com.echothree.model.data.sequence.server.entity.SequenceType;

import com.echothree.model.data.cancellationpolicy.server.factory.CancellationKindFactory;
import com.echothree.model.data.sequence.server.factory.SequenceTypeFactory;

import com.echothree.model.data.cancellationpolicy.common.pk.CancellationKindDetailPK;

import com.echothree.model.data.cancellationpolicy.server.value.CancellationKindDetailValue;

import com.echothree.model.data.cancellationpolicy.server.factory.CancellationKindDetailFactory;

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 CancellationKindDetail
        extends BaseEntity
        implements Serializable {
    
    private CancellationKindDetailPK _pk;
    private CancellationKindDetailValue _value;
    
    /** Creates a new instance of CancellationKindDetail */
    public CancellationKindDetail()
            throws PersistenceException {
        super();
    }
    
    /** Creates a new instance of CancellationKindDetail */
    public CancellationKindDetail(CancellationKindDetailValue value, EntityPermission entityPermission) {
        super(entityPermission);
        
        _value = value;
        _pk = value.getPrimaryKey();
    }
    
    @Override
    @Nonnull
    public CancellationKindDetailFactory getBaseFactoryInstance() {
        return CancellationKindDetailFactory.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 CancellationKindDetail that) {
            CancellationKindDetailValue thatValue = that.getCancellationKindDetailValue();
            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 CancellationKindDetailValue getCancellationKindDetailValue() {
        return _value;
    }
    
    public void setCancellationKindDetailValue(@Nonnull CancellationKindDetailValue value)
            throws PersistenceReadOnlyException {
        checkReadWrite();
        _value = value;
    }
    
    @Override
    @Nonnull
    public CancellationKindDetailPK getPrimaryKey() {
        return _pk;
    }
    
    @Nonnull
    public CancellationKindPK getCancellationKindPK() {
        return _value.getCancellationKindPK();
    }
    
    @Nonnull
    public CancellationKind getCancellationKind(EntityPermission entityPermission) {
        return CancellationKindFactory.getInstance().getEntityFromPK(entityPermission, getCancellationKindPK());
    }
    
    @Nonnull
    public CancellationKind getCancellationKind() {
        return getCancellationKind(EntityPermission.READ_ONLY);
    }
    
    @Nonnull
    public CancellationKind getCancellationKindForUpdate() {
        return getCancellationKind(EntityPermission.READ_WRITE);
    }
    
    public void setCancellationKindPK(@Nonnull CancellationKindPK cancellationKindPK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setCancellationKindPK(cancellationKindPK);
    }
    
    public void setCancellationKind(@Nonnull CancellationKind entity) {
        setCancellationKindPK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getCancellationKindPKHasBeenModified() {
        return _value.getCancellationKindPKHasBeenModified();
    }
    
    @Nonnull
    public String getCancellationKindName() {
        return _value.getCancellationKindName();
    }
    
    public void setCancellationKindName(@Nonnull String cancellationKindName)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setCancellationKindName(cancellationKindName);
    }
    
    public boolean getCancellationKindNameHasBeenModified() {
        return _value.getCancellationKindNameHasBeenModified();
    }
    
    @Nonnull
    public SequenceTypePK getCancellationSequenceTypePK() {
        return _value.getCancellationSequenceTypePK();
    }
    
    @Nonnull
    public SequenceType getCancellationSequenceType(EntityPermission entityPermission) {
        return SequenceTypeFactory.getInstance().getEntityFromPK(entityPermission, getCancellationSequenceTypePK());
    }
    
    @Nonnull
    public SequenceType getCancellationSequenceType() {
        return getCancellationSequenceType(EntityPermission.READ_ONLY);
    }
    
    @Nonnull
    public SequenceType getCancellationSequenceTypeForUpdate() {
        return getCancellationSequenceType(EntityPermission.READ_WRITE);
    }
    
    public void setCancellationSequenceTypePK(@Nonnull SequenceTypePK cancellationSequenceTypePK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setCancellationSequenceTypePK(cancellationSequenceTypePK);
    }
    
    public void setCancellationSequenceType(@Nonnull SequenceType entity) {
        setCancellationSequenceTypePK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getCancellationSequenceTypePKHasBeenModified() {
        return _value.getCancellationSequenceTypePKHasBeenModified();
    }
    
    @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();
    }
    
}