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

/**
 * CampaignDetail.java
 */

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

import com.echothree.model.data.campaign.common.pk.CampaignDetailPK;

import com.echothree.model.data.campaign.common.pk.CampaignPK;

import com.echothree.model.data.campaign.server.entity.Campaign;

import com.echothree.model.data.campaign.server.factory.CampaignFactory;

import com.echothree.model.data.campaign.common.pk.CampaignDetailPK;

import com.echothree.model.data.campaign.server.value.CampaignDetailValue;

import com.echothree.model.data.campaign.server.factory.CampaignDetailFactory;

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 CampaignDetail
        extends BaseEntity
        implements Serializable {
    
    private CampaignDetailPK _pk;
    private CampaignDetailValue _value;
    
    /** Creates a new instance of CampaignDetail */
    public CampaignDetail()
            throws PersistenceException {
        super();
    }
    
    /** Creates a new instance of CampaignDetail */
    public CampaignDetail(CampaignDetailValue value, EntityPermission entityPermission) {
        super(entityPermission);
        
        _value = value;
        _pk = value.getPrimaryKey();
    }
    
    @Override
    @Nonnull
    public CampaignDetailFactory getBaseFactoryInstance() {
        return CampaignDetailFactory.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 CampaignDetail that) {
            CampaignDetailValue thatValue = that.getCampaignDetailValue();
            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 CampaignDetailValue getCampaignDetailValue() {
        return _value;
    }
    
    public void setCampaignDetailValue(@Nonnull CampaignDetailValue value)
            throws PersistenceReadOnlyException {
        checkReadWrite();
        _value = value;
    }
    
    @Override
    @Nonnull
    public CampaignDetailPK getPrimaryKey() {
        return _pk;
    }
    
    @Nonnull
    public CampaignPK getCampaignPK() {
        return _value.getCampaignPK();
    }
    
    @Nonnull
    public Campaign getCampaign(EntityPermission entityPermission) {
        return CampaignFactory.getInstance().getEntityFromPK(entityPermission, getCampaignPK());
    }
    
    @Nonnull
    public Campaign getCampaign() {
        return getCampaign(EntityPermission.READ_ONLY);
    }
    
    @Nonnull
    public Campaign getCampaignForUpdate() {
        return getCampaign(EntityPermission.READ_WRITE);
    }
    
    public void setCampaignPK(@Nonnull CampaignPK campaignPK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setCampaignPK(campaignPK);
    }
    
    public void setCampaign(@Nonnull Campaign entity) {
        setCampaignPK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getCampaignPKHasBeenModified() {
        return _value.getCampaignPKHasBeenModified();
    }
    
    @Nonnull
    public String getCampaignName() {
        return _value.getCampaignName();
    }
    
    public void setCampaignName(@Nonnull String campaignName)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setCampaignName(campaignName);
    }
    
    public boolean getCampaignNameHasBeenModified() {
        return _value.getCampaignNameHasBeenModified();
    }
    
    @Nonnull
    public String getValueSha1Hash() {
        return _value.getValueSha1Hash();
    }
    
    public void setValueSha1Hash(@Nonnull String valueSha1Hash)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setValueSha1Hash(valueSha1Hash);
    }
    
    public boolean getValueSha1HashHasBeenModified() {
        return _value.getValueSha1HashHasBeenModified();
    }
    
    @Nonnull
    public String getValue() {
        return _value.getValue();
    }
    
    public void setValue(@Nonnull String value)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setValue(value);
    }
    
    public boolean getValueHasBeenModified() {
        return _value.getValueHasBeenModified();
    }
    
    @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();
    }
    
}