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

/**
 * Event.java
 */

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

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

import com.echothree.model.data.core.common.pk.EventGroupPK;
import com.echothree.model.data.core.common.pk.EntityInstancePK;
import com.echothree.model.data.core.common.pk.EventTypePK;

import com.echothree.model.data.core.server.entity.EventGroup;
import com.echothree.model.data.core.server.entity.EntityInstance;
import com.echothree.model.data.core.server.entity.EventType;

import com.echothree.model.data.core.server.factory.EventGroupFactory;
import com.echothree.model.data.core.server.factory.EntityInstanceFactory;
import com.echothree.model.data.core.server.factory.EventTypeFactory;

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

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

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

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 Event
        extends BaseEntity
        implements Serializable {
    
    private EventPK _pk;
    private EventValue _value;
    
    /** Creates a new instance of Event */
    public Event()
            throws PersistenceException {
        super();
    }
    
    /** Creates a new instance of Event */
    public Event(EventValue value, EntityPermission entityPermission) {
        super(entityPermission);
        
        _value = value;
        _pk = value.getPrimaryKey();
    }
    
    @Override
    @Nonnull
    public EventFactory getBaseFactoryInstance() {
        return EventFactory.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 Event that) {
            EventValue thatValue = that.getEventValue();
            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 EventValue getEventValue() {
        return _value;
    }
    
    public void setEventValue(@Nonnull EventValue value)
            throws PersistenceReadOnlyException {
        checkReadWrite();
        _value = value;
    }
    
    @Override
    @Nonnull
    public EventPK getPrimaryKey() {
        return _pk;
    }
    
    @Nullable
    public EventGroupPK getEventGroupPK() {
        return _value.getEventGroupPK();
    }
    
    @Nullable
    public EventGroup getEventGroup(EntityPermission entityPermission) {
        EventGroupPK pk = getEventGroupPK();
        EventGroup entity = pk == null? null: EventGroupFactory.getInstance().getEntityFromPK(entityPermission, pk);
        
        return entity;
    }
    
    @Nullable
    public EventGroup getEventGroup() {
        return getEventGroup(EntityPermission.READ_ONLY);
    }
    
    @Nullable
    public EventGroup getEventGroupForUpdate() {
        return getEventGroup(EntityPermission.READ_WRITE);
    }
    
    public void setEventGroupPK(@Nullable EventGroupPK eventGroupPK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setEventGroupPK(eventGroupPK);
    }
    
    public void setEventGroup(@Nullable EventGroup entity) {
        setEventGroupPK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getEventGroupPKHasBeenModified() {
        return _value.getEventGroupPKHasBeenModified();
    }
    
    @Nonnull
    public Long getEventTime() {
        return _value.getEventTime();
    }
    
    public void setEventTime(@Nonnull Long eventTime)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setEventTime(eventTime);
    }
    
    public boolean getEventTimeHasBeenModified() {
        return _value.getEventTimeHasBeenModified();
    }
    
    @Nonnull
    public Integer getEventTimeSequence() {
        return _value.getEventTimeSequence();
    }
    
    public void setEventTimeSequence(@Nonnull Integer eventTimeSequence)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setEventTimeSequence(eventTimeSequence);
    }
    
    public boolean getEventTimeSequenceHasBeenModified() {
        return _value.getEventTimeSequenceHasBeenModified();
    }
    
    @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();
    }
    
    @Nonnull
    public EventTypePK getEventTypePK() {
        return _value.getEventTypePK();
    }
    
    @Nonnull
    public EventType getEventType(EntityPermission entityPermission) {
        return EventTypeFactory.getInstance().getEntityFromPK(entityPermission, getEventTypePK());
    }
    
    @Nonnull
    public EventType getEventType() {
        return getEventType(EntityPermission.READ_ONLY);
    }
    
    @Nonnull
    public EventType getEventTypeForUpdate() {
        return getEventType(EntityPermission.READ_WRITE);
    }
    
    public void setEventTypePK(@Nonnull EventTypePK eventTypePK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setEventTypePK(eventTypePK);
    }
    
    public void setEventType(@Nonnull EventType entity) {
        setEventTypePK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getEventTypePKHasBeenModified() {
        return _value.getEventTypePKHasBeenModified();
    }
    
    @Nullable
    public EntityInstancePK getRelatedEntityInstancePK() {
        return _value.getRelatedEntityInstancePK();
    }
    
    @Nullable
    public EntityInstance getRelatedEntityInstance(EntityPermission entityPermission) {
        EntityInstancePK pk = getRelatedEntityInstancePK();
        EntityInstance entity = pk == null? null: EntityInstanceFactory.getInstance().getEntityFromPK(entityPermission, pk);
        
        return entity;
    }
    
    @Nullable
    public EntityInstance getRelatedEntityInstance() {
        return getRelatedEntityInstance(EntityPermission.READ_ONLY);
    }
    
    @Nullable
    public EntityInstance getRelatedEntityInstanceForUpdate() {
        return getRelatedEntityInstance(EntityPermission.READ_WRITE);
    }
    
    public void setRelatedEntityInstancePK(@Nullable EntityInstancePK relatedEntityInstancePK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setRelatedEntityInstancePK(relatedEntityInstancePK);
    }
    
    public void setRelatedEntityInstance(@Nullable EntityInstance entity) {
        setRelatedEntityInstancePK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getRelatedEntityInstancePKHasBeenModified() {
        return _value.getRelatedEntityInstancePKHasBeenModified();
    }
    
    @Nullable
    public EventTypePK getRelatedEventTypePK() {
        return _value.getRelatedEventTypePK();
    }
    
    @Nullable
    public EventType getRelatedEventType(EntityPermission entityPermission) {
        EventTypePK pk = getRelatedEventTypePK();
        EventType entity = pk == null? null: EventTypeFactory.getInstance().getEntityFromPK(entityPermission, pk);
        
        return entity;
    }
    
    @Nullable
    public EventType getRelatedEventType() {
        return getRelatedEventType(EntityPermission.READ_ONLY);
    }
    
    @Nullable
    public EventType getRelatedEventTypeForUpdate() {
        return getRelatedEventType(EntityPermission.READ_WRITE);
    }
    
    public void setRelatedEventTypePK(@Nullable EventTypePK relatedEventTypePK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setRelatedEventTypePK(relatedEventTypePK);
    }
    
    public void setRelatedEventType(@Nullable EventType entity) {
        setRelatedEventTypePK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getRelatedEventTypePKHasBeenModified() {
        return _value.getRelatedEventTypePKHasBeenModified();
    }
    
    @Nullable
    public EntityInstancePK getCreatedByPK() {
        return _value.getCreatedByPK();
    }
    
    @Nullable
    public EntityInstance getCreatedBy(EntityPermission entityPermission) {
        EntityInstancePK pk = getCreatedByPK();
        EntityInstance entity = pk == null? null: EntityInstanceFactory.getInstance().getEntityFromPK(entityPermission, pk);
        
        return entity;
    }
    
    @Nullable
    public EntityInstance getCreatedBy() {
        return getCreatedBy(EntityPermission.READ_ONLY);
    }
    
    @Nullable
    public EntityInstance getCreatedByForUpdate() {
        return getCreatedBy(EntityPermission.READ_WRITE);
    }
    
    public void setCreatedByPK(@Nullable EntityInstancePK createdByPK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setCreatedByPK(createdByPK);
    }
    
    public void setCreatedBy(@Nullable EntityInstance entity) {
        setCreatedByPK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getCreatedByPKHasBeenModified() {
        return _value.getCreatedByPKHasBeenModified();
    }
    
}