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

/**
 * AssociateProgramDetail.java
 */

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

import com.echothree.model.data.associate.common.pk.AssociateProgramDetailPK;

import com.echothree.model.data.associate.common.pk.AssociateProgramPK;
import com.echothree.model.data.sequence.common.pk.SequencePK;

import com.echothree.model.data.associate.server.entity.AssociateProgram;
import com.echothree.model.data.sequence.server.entity.Sequence;

import com.echothree.model.data.associate.server.factory.AssociateProgramFactory;
import com.echothree.model.data.sequence.server.factory.SequenceFactory;

import com.echothree.model.data.associate.common.pk.AssociateProgramDetailPK;

import com.echothree.model.data.associate.server.value.AssociateProgramDetailValue;

import com.echothree.model.data.associate.server.factory.AssociateProgramDetailFactory;

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 AssociateProgramDetail
        extends BaseEntity
        implements Serializable {
    
    private AssociateProgramDetailPK _pk;
    private AssociateProgramDetailValue _value;
    
    /** Creates a new instance of AssociateProgramDetail */
    public AssociateProgramDetail()
            throws PersistenceException {
        super();
    }
    
    /** Creates a new instance of AssociateProgramDetail */
    public AssociateProgramDetail(AssociateProgramDetailValue value, EntityPermission entityPermission) {
        super(entityPermission);
        
        _value = value;
        _pk = value.getPrimaryKey();
    }
    
    @Override
    @Nonnull
    public AssociateProgramDetailFactory getBaseFactoryInstance() {
        return AssociateProgramDetailFactory.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 AssociateProgramDetail that) {
            AssociateProgramDetailValue thatValue = that.getAssociateProgramDetailValue();
            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 AssociateProgramDetailValue getAssociateProgramDetailValue() {
        return _value;
    }
    
    public void setAssociateProgramDetailValue(@Nonnull AssociateProgramDetailValue value)
            throws PersistenceReadOnlyException {
        checkReadWrite();
        _value = value;
    }
    
    @Override
    @Nonnull
    public AssociateProgramDetailPK getPrimaryKey() {
        return _pk;
    }
    
    @Nullable
    public AssociateProgramPK getAssociateProgramPK() {
        return _value.getAssociateProgramPK();
    }
    
    @Nullable
    public AssociateProgram getAssociateProgram(EntityPermission entityPermission) {
        AssociateProgramPK pk = getAssociateProgramPK();
        AssociateProgram entity = pk == null? null: AssociateProgramFactory.getInstance().getEntityFromPK(entityPermission, pk);
        
        return entity;
    }
    
    @Nullable
    public AssociateProgram getAssociateProgram() {
        return getAssociateProgram(EntityPermission.READ_ONLY);
    }
    
    @Nullable
    public AssociateProgram getAssociateProgramForUpdate() {
        return getAssociateProgram(EntityPermission.READ_WRITE);
    }
    
    public void setAssociateProgramPK(@Nullable AssociateProgramPK associateProgramPK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setAssociateProgramPK(associateProgramPK);
    }
    
    public void setAssociateProgram(@Nullable AssociateProgram entity) {
        setAssociateProgramPK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getAssociateProgramPKHasBeenModified() {
        return _value.getAssociateProgramPKHasBeenModified();
    }
    
    @Nonnull
    public String getAssociateProgramName() {
        return _value.getAssociateProgramName();
    }
    
    public void setAssociateProgramName(@Nonnull String associateProgramName)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setAssociateProgramName(associateProgramName);
    }
    
    public boolean getAssociateProgramNameHasBeenModified() {
        return _value.getAssociateProgramNameHasBeenModified();
    }
    
    @Nullable
    public SequencePK getAssociateSequencePK() {
        return _value.getAssociateSequencePK();
    }
    
    @Nullable
    public Sequence getAssociateSequence(EntityPermission entityPermission) {
        SequencePK pk = getAssociateSequencePK();
        Sequence entity = pk == null? null: SequenceFactory.getInstance().getEntityFromPK(entityPermission, pk);
        
        return entity;
    }
    
    @Nullable
    public Sequence getAssociateSequence() {
        return getAssociateSequence(EntityPermission.READ_ONLY);
    }
    
    @Nullable
    public Sequence getAssociateSequenceForUpdate() {
        return getAssociateSequence(EntityPermission.READ_WRITE);
    }
    
    public void setAssociateSequencePK(@Nullable SequencePK associateSequencePK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setAssociateSequencePK(associateSequencePK);
    }
    
    public void setAssociateSequence(@Nullable Sequence entity) {
        setAssociateSequencePK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getAssociateSequencePKHasBeenModified() {
        return _value.getAssociateSequencePKHasBeenModified();
    }
    
    @Nullable
    public SequencePK getAssociatePartyContactMechanismSequencePK() {
        return _value.getAssociatePartyContactMechanismSequencePK();
    }
    
    @Nullable
    public Sequence getAssociatePartyContactMechanismSequence(EntityPermission entityPermission) {
        SequencePK pk = getAssociatePartyContactMechanismSequencePK();
        Sequence entity = pk == null? null: SequenceFactory.getInstance().getEntityFromPK(entityPermission, pk);
        
        return entity;
    }
    
    @Nullable
    public Sequence getAssociatePartyContactMechanismSequence() {
        return getAssociatePartyContactMechanismSequence(EntityPermission.READ_ONLY);
    }
    
    @Nullable
    public Sequence getAssociatePartyContactMechanismSequenceForUpdate() {
        return getAssociatePartyContactMechanismSequence(EntityPermission.READ_WRITE);
    }
    
    public void setAssociatePartyContactMechanismSequencePK(@Nullable SequencePK associatePartyContactMechanismSequencePK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setAssociatePartyContactMechanismSequencePK(associatePartyContactMechanismSequencePK);
    }
    
    public void setAssociatePartyContactMechanismSequence(@Nullable Sequence entity) {
        setAssociatePartyContactMechanismSequencePK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getAssociatePartyContactMechanismSequencePKHasBeenModified() {
        return _value.getAssociatePartyContactMechanismSequencePKHasBeenModified();
    }
    
    @Nullable
    public SequencePK getAssociateReferralSequencePK() {
        return _value.getAssociateReferralSequencePK();
    }
    
    @Nullable
    public Sequence getAssociateReferralSequence(EntityPermission entityPermission) {
        SequencePK pk = getAssociateReferralSequencePK();
        Sequence entity = pk == null? null: SequenceFactory.getInstance().getEntityFromPK(entityPermission, pk);
        
        return entity;
    }
    
    @Nullable
    public Sequence getAssociateReferralSequence() {
        return getAssociateReferralSequence(EntityPermission.READ_ONLY);
    }
    
    @Nullable
    public Sequence getAssociateReferralSequenceForUpdate() {
        return getAssociateReferralSequence(EntityPermission.READ_WRITE);
    }
    
    public void setAssociateReferralSequencePK(@Nullable SequencePK associateReferralSequencePK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setAssociateReferralSequencePK(associateReferralSequencePK);
    }
    
    public void setAssociateReferralSequence(@Nullable Sequence entity) {
        setAssociateReferralSequencePK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getAssociateReferralSequencePKHasBeenModified() {
        return _value.getAssociateReferralSequencePKHasBeenModified();
    }
    
    @Nullable
    public Integer getItemIndirectSalePercent() {
        return _value.getItemIndirectSalePercent();
    }
    
    public void setItemIndirectSalePercent(@Nullable Integer itemIndirectSalePercent)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setItemIndirectSalePercent(itemIndirectSalePercent);
    }
    
    public boolean getItemIndirectSalePercentHasBeenModified() {
        return _value.getItemIndirectSalePercentHasBeenModified();
    }
    
    @Nullable
    public Integer getItemDirectSalePercent() {
        return _value.getItemDirectSalePercent();
    }
    
    public void setItemDirectSalePercent(@Nullable Integer itemDirectSalePercent)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setItemDirectSalePercent(itemDirectSalePercent);
    }
    
    public boolean getItemDirectSalePercentHasBeenModified() {
        return _value.getItemDirectSalePercentHasBeenModified();
    }
    
    @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();
    }
    
}