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

/**
 * EventSubscriberDetail.java
 */

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

import com.echothree.model.data.core.common.pk.EventSubscriberDetailPK;

import com.echothree.model.data.core.common.pk.EventSubscriberPK;
import com.echothree.model.data.core.common.pk.EntityInstancePK;

import com.echothree.model.data.core.server.entity.EventSubscriber;
import com.echothree.model.data.core.server.entity.EntityInstance;

import com.echothree.model.data.core.server.factory.EventSubscriberFactory;
import com.echothree.model.data.core.server.factory.EntityInstanceFactory;

import com.echothree.model.data.core.common.pk.EventSubscriberDetailPK;

import com.echothree.model.data.core.server.value.EventSubscriberDetailValue;

import com.echothree.model.data.core.server.factory.EventSubscriberDetailFactory;

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 EventSubscriberDetail
        extends BaseEntity
        implements Serializable {
    
    private EventSubscriberDetailPK _pk;
    private EventSubscriberDetailValue _value;
    
    /** Creates a new instance of EventSubscriberDetail */
    public EventSubscriberDetail()
            throws PersistenceException {
        super();
    }
    
    /** Creates a new instance of EventSubscriberDetail */
    public EventSubscriberDetail(EventSubscriberDetailValue value, EntityPermission entityPermission) {
        super(entityPermission);
        
        _value = value;
        _pk = value.getPrimaryKey();
    }
    
    @Override
    @Nonnull
    public EventSubscriberDetailFactory getBaseFactoryInstance() {
        return EventSubscriberDetailFactory.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 EventSubscriberDetail that) {
            EventSubscriberDetailValue thatValue = that.getEventSubscriberDetailValue();
            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 EventSubscriberDetailValue getEventSubscriberDetailValue() {
        return _value;
    }
    
    public void setEventSubscriberDetailValue(@Nonnull EventSubscriberDetailValue value)
            throws PersistenceReadOnlyException {
        checkReadWrite();
        _value = value;
    }
    
    @Override
    @Nonnull
    public EventSubscriberDetailPK getPrimaryKey() {
        return _pk;
    }
    
    @Nonnull
    public EventSubscriberPK getEventSubscriberPK() {
        return _value.getEventSubscriberPK();
    }
    
    @Nonnull
    public EventSubscriber getEventSubscriber(EntityPermission entityPermission) {
        return EventSubscriberFactory.getInstance().getEntityFromPK(entityPermission, getEventSubscriberPK());
    }
    
    @Nonnull
    public EventSubscriber getEventSubscriber() {
        return getEventSubscriber(EntityPermission.READ_ONLY);
    }
    
    @Nonnull
    public EventSubscriber getEventSubscriberForUpdate() {
        return getEventSubscriber(EntityPermission.READ_WRITE);
    }
    
    public void setEventSubscriberPK(@Nonnull EventSubscriberPK eventSubscriberPK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setEventSubscriberPK(eventSubscriberPK);
    }
    
    public void setEventSubscriber(@Nonnull EventSubscriber entity) {
        setEventSubscriberPK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getEventSubscriberPKHasBeenModified() {
        return _value.getEventSubscriberPKHasBeenModified();
    }
    
    @Nonnull
    public String getEventSubscriberName() {
        return _value.getEventSubscriberName();
    }
    
    public void setEventSubscriberName(@Nonnull String eventSubscriberName)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setEventSubscriberName(eventSubscriberName);
    }
    
    public boolean getEventSubscriberNameHasBeenModified() {
        return _value.getEventSubscriberNameHasBeenModified();
    }
    
    @Nonnull
    public EntityInstancePK getEntityInstancePK() {
        return _value.getEntityInstancePK();
    }
    
    @Nonnull
    public EntityInstance getEntityInstance(EntityPermission entityPermission) {
        return EntityInstanceFactory.getInstance().getEntityFromPK(entityPermission, getEntityInstancePK());
    }
    
    @Nonnull
    public EntityInstance getEntityInstance() {
        return getEntityInstance(EntityPermission.READ_ONLY);
    }
    
    @Nonnull
    public EntityInstance getEntityInstanceForUpdate() {
        return getEntityInstance(EntityPermission.READ_WRITE);
    }
    
    public void setEntityInstancePK(@Nonnull EntityInstancePK entityInstancePK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setEntityInstancePK(entityInstancePK);
    }
    
    public void setEntityInstance(@Nonnull EntityInstance entity) {
        setEntityInstancePK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getEntityInstancePKHasBeenModified() {
        return _value.getEntityInstancePKHasBeenModified();
    }
    
    @Nullable
    public String getDescription() {
        return _value.getDescription();
    }
    
    public void setDescription(@Nullable String description)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setDescription(description);
    }
    
    public boolean getDescriptionHasBeenModified() {
        return _value.getDescriptionHasBeenModified();
    }
    
    @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();
    }
    
}