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

/**
 * CommunicationEventDetail.java
 */

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

import com.echothree.model.data.communication.common.pk.CommunicationEventDetailPK;

import com.echothree.model.data.communication.common.pk.CommunicationEventPK;
import com.echothree.model.data.communication.common.pk.CommunicationEventTypePK;
import com.echothree.model.data.communication.common.pk.CommunicationSourcePK;
import com.echothree.model.data.communication.common.pk.CommunicationEventPurposePK;
import com.echothree.model.data.contact.common.pk.PartyContactMechanismPK;
import com.echothree.model.data.document.common.pk.DocumentPK;

import com.echothree.model.data.communication.server.entity.CommunicationEvent;
import com.echothree.model.data.communication.server.entity.CommunicationEventType;
import com.echothree.model.data.communication.server.entity.CommunicationSource;
import com.echothree.model.data.communication.server.entity.CommunicationEventPurpose;
import com.echothree.model.data.contact.server.entity.PartyContactMechanism;
import com.echothree.model.data.document.server.entity.Document;

import com.echothree.model.data.communication.server.factory.CommunicationEventFactory;
import com.echothree.model.data.communication.server.factory.CommunicationEventTypeFactory;
import com.echothree.model.data.communication.server.factory.CommunicationSourceFactory;
import com.echothree.model.data.communication.server.factory.CommunicationEventPurposeFactory;
import com.echothree.model.data.contact.server.factory.PartyContactMechanismFactory;
import com.echothree.model.data.document.server.factory.DocumentFactory;

import com.echothree.model.data.communication.common.pk.CommunicationEventDetailPK;

import com.echothree.model.data.communication.server.value.CommunicationEventDetailValue;

import com.echothree.model.data.communication.server.factory.CommunicationEventDetailFactory;

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 CommunicationEventDetail
        extends BaseEntity
        implements Serializable {
    
    private CommunicationEventDetailPK _pk;
    private CommunicationEventDetailValue _value;
    
    /** Creates a new instance of CommunicationEventDetail */
    public CommunicationEventDetail()
            throws PersistenceException {
        super();
    }
    
    /** Creates a new instance of CommunicationEventDetail */
    public CommunicationEventDetail(CommunicationEventDetailValue value, EntityPermission entityPermission) {
        super(entityPermission);
        
        _value = value;
        _pk = value.getPrimaryKey();
    }
    
    @Override
    @Nonnull
    public CommunicationEventDetailFactory getBaseFactoryInstance() {
        return CommunicationEventDetailFactory.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 CommunicationEventDetail that) {
            CommunicationEventDetailValue thatValue = that.getCommunicationEventDetailValue();
            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 CommunicationEventDetailValue getCommunicationEventDetailValue() {
        return _value;
    }
    
    public void setCommunicationEventDetailValue(@Nonnull CommunicationEventDetailValue value)
            throws PersistenceReadOnlyException {
        checkReadWrite();
        _value = value;
    }
    
    @Override
    @Nonnull
    public CommunicationEventDetailPK getPrimaryKey() {
        return _pk;
    }
    
    @Nonnull
    public CommunicationEventPK getCommunicationEventPK() {
        return _value.getCommunicationEventPK();
    }
    
    @Nonnull
    public CommunicationEvent getCommunicationEvent(EntityPermission entityPermission) {
        return CommunicationEventFactory.getInstance().getEntityFromPK(entityPermission, getCommunicationEventPK());
    }
    
    @Nonnull
    public CommunicationEvent getCommunicationEvent() {
        return getCommunicationEvent(EntityPermission.READ_ONLY);
    }
    
    @Nonnull
    public CommunicationEvent getCommunicationEventForUpdate() {
        return getCommunicationEvent(EntityPermission.READ_WRITE);
    }
    
    public void setCommunicationEventPK(@Nonnull CommunicationEventPK communicationEventPK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setCommunicationEventPK(communicationEventPK);
    }
    
    public void setCommunicationEvent(@Nonnull CommunicationEvent entity) {
        setCommunicationEventPK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getCommunicationEventPKHasBeenModified() {
        return _value.getCommunicationEventPKHasBeenModified();
    }
    
    @Nonnull
    public String getCommunicationEventName() {
        return _value.getCommunicationEventName();
    }
    
    public void setCommunicationEventName(@Nonnull String communicationEventName)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setCommunicationEventName(communicationEventName);
    }
    
    public boolean getCommunicationEventNameHasBeenModified() {
        return _value.getCommunicationEventNameHasBeenModified();
    }
    
    @Nonnull
    public CommunicationEventTypePK getCommunicationEventTypePK() {
        return _value.getCommunicationEventTypePK();
    }
    
    @Nonnull
    public CommunicationEventType getCommunicationEventType(EntityPermission entityPermission) {
        return CommunicationEventTypeFactory.getInstance().getEntityFromPK(entityPermission, getCommunicationEventTypePK());
    }
    
    @Nonnull
    public CommunicationEventType getCommunicationEventType() {
        return getCommunicationEventType(EntityPermission.READ_ONLY);
    }
    
    @Nonnull
    public CommunicationEventType getCommunicationEventTypeForUpdate() {
        return getCommunicationEventType(EntityPermission.READ_WRITE);
    }
    
    public void setCommunicationEventTypePK(@Nonnull CommunicationEventTypePK communicationEventTypePK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setCommunicationEventTypePK(communicationEventTypePK);
    }
    
    public void setCommunicationEventType(@Nonnull CommunicationEventType entity) {
        setCommunicationEventTypePK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getCommunicationEventTypePKHasBeenModified() {
        return _value.getCommunicationEventTypePKHasBeenModified();
    }
    
    @Nullable
    public CommunicationSourcePK getCommunicationSourcePK() {
        return _value.getCommunicationSourcePK();
    }
    
    @Nullable
    public CommunicationSource getCommunicationSource(EntityPermission entityPermission) {
        CommunicationSourcePK pk = getCommunicationSourcePK();
        CommunicationSource entity = pk == null? null: CommunicationSourceFactory.getInstance().getEntityFromPK(entityPermission, pk);
        
        return entity;
    }
    
    @Nullable
    public CommunicationSource getCommunicationSource() {
        return getCommunicationSource(EntityPermission.READ_ONLY);
    }
    
    @Nullable
    public CommunicationSource getCommunicationSourceForUpdate() {
        return getCommunicationSource(EntityPermission.READ_WRITE);
    }
    
    public void setCommunicationSourcePK(@Nullable CommunicationSourcePK communicationSourcePK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setCommunicationSourcePK(communicationSourcePK);
    }
    
    public void setCommunicationSource(@Nullable CommunicationSource entity) {
        setCommunicationSourcePK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getCommunicationSourcePKHasBeenModified() {
        return _value.getCommunicationSourcePKHasBeenModified();
    }
    
    @Nonnull
    public CommunicationEventPurposePK getCommunicationEventPurposePK() {
        return _value.getCommunicationEventPurposePK();
    }
    
    @Nonnull
    public CommunicationEventPurpose getCommunicationEventPurpose(EntityPermission entityPermission) {
        return CommunicationEventPurposeFactory.getInstance().getEntityFromPK(entityPermission, getCommunicationEventPurposePK());
    }
    
    @Nonnull
    public CommunicationEventPurpose getCommunicationEventPurpose() {
        return getCommunicationEventPurpose(EntityPermission.READ_ONLY);
    }
    
    @Nonnull
    public CommunicationEventPurpose getCommunicationEventPurposeForUpdate() {
        return getCommunicationEventPurpose(EntityPermission.READ_WRITE);
    }
    
    public void setCommunicationEventPurposePK(@Nonnull CommunicationEventPurposePK communicationEventPurposePK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setCommunicationEventPurposePK(communicationEventPurposePK);
    }
    
    public void setCommunicationEventPurpose(@Nonnull CommunicationEventPurpose entity) {
        setCommunicationEventPurposePK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getCommunicationEventPurposePKHasBeenModified() {
        return _value.getCommunicationEventPurposePKHasBeenModified();
    }
    
    @Nullable
    public CommunicationEventPK getOriginalCommunicationEventPK() {
        return _value.getOriginalCommunicationEventPK();
    }
    
    @Nullable
    public CommunicationEvent getOriginalCommunicationEvent(EntityPermission entityPermission) {
        CommunicationEventPK pk = getOriginalCommunicationEventPK();
        CommunicationEvent entity = pk == null? null: CommunicationEventFactory.getInstance().getEntityFromPK(entityPermission, pk);
        
        return entity;
    }
    
    @Nullable
    public CommunicationEvent getOriginalCommunicationEvent() {
        return getOriginalCommunicationEvent(EntityPermission.READ_ONLY);
    }
    
    @Nullable
    public CommunicationEvent getOriginalCommunicationEventForUpdate() {
        return getOriginalCommunicationEvent(EntityPermission.READ_WRITE);
    }
    
    public void setOriginalCommunicationEventPK(@Nullable CommunicationEventPK originalCommunicationEventPK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setOriginalCommunicationEventPK(originalCommunicationEventPK);
    }
    
    public void setOriginalCommunicationEvent(@Nullable CommunicationEvent entity) {
        setOriginalCommunicationEventPK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getOriginalCommunicationEventPKHasBeenModified() {
        return _value.getOriginalCommunicationEventPKHasBeenModified();
    }
    
    @Nullable
    public CommunicationEventPK getParentCommunicationEventPK() {
        return _value.getParentCommunicationEventPK();
    }
    
    @Nullable
    public CommunicationEvent getParentCommunicationEvent(EntityPermission entityPermission) {
        CommunicationEventPK pk = getParentCommunicationEventPK();
        CommunicationEvent entity = pk == null? null: CommunicationEventFactory.getInstance().getEntityFromPK(entityPermission, pk);
        
        return entity;
    }
    
    @Nullable
    public CommunicationEvent getParentCommunicationEvent() {
        return getParentCommunicationEvent(EntityPermission.READ_ONLY);
    }
    
    @Nullable
    public CommunicationEvent getParentCommunicationEventForUpdate() {
        return getParentCommunicationEvent(EntityPermission.READ_WRITE);
    }
    
    public void setParentCommunicationEventPK(@Nullable CommunicationEventPK parentCommunicationEventPK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setParentCommunicationEventPK(parentCommunicationEventPK);
    }
    
    public void setParentCommunicationEvent(@Nullable CommunicationEvent entity) {
        setParentCommunicationEventPK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getParentCommunicationEventPKHasBeenModified() {
        return _value.getParentCommunicationEventPKHasBeenModified();
    }
    
    @Nonnull
    public PartyContactMechanismPK getPartyContactMechanismPK() {
        return _value.getPartyContactMechanismPK();
    }
    
    @Nonnull
    public PartyContactMechanism getPartyContactMechanism(EntityPermission entityPermission) {
        return PartyContactMechanismFactory.getInstance().getEntityFromPK(entityPermission, getPartyContactMechanismPK());
    }
    
    @Nonnull
    public PartyContactMechanism getPartyContactMechanism() {
        return getPartyContactMechanism(EntityPermission.READ_ONLY);
    }
    
    @Nonnull
    public PartyContactMechanism getPartyContactMechanismForUpdate() {
        return getPartyContactMechanism(EntityPermission.READ_WRITE);
    }
    
    public void setPartyContactMechanismPK(@Nonnull PartyContactMechanismPK partyContactMechanismPK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setPartyContactMechanismPK(partyContactMechanismPK);
    }
    
    public void setPartyContactMechanism(@Nonnull PartyContactMechanism entity) {
        setPartyContactMechanismPK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getPartyContactMechanismPKHasBeenModified() {
        return _value.getPartyContactMechanismPKHasBeenModified();
    }
    
    @Nonnull
    public DocumentPK getDocumentPK() {
        return _value.getDocumentPK();
    }
    
    @Nonnull
    public Document getDocument(EntityPermission entityPermission) {
        return DocumentFactory.getInstance().getEntityFromPK(entityPermission, getDocumentPK());
    }
    
    @Nonnull
    public Document getDocument() {
        return getDocument(EntityPermission.READ_ONLY);
    }
    
    @Nonnull
    public Document getDocumentForUpdate() {
        return getDocument(EntityPermission.READ_WRITE);
    }
    
    public void setDocumentPK(@Nonnull DocumentPK documentPK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setDocumentPK(documentPK);
    }
    
    public void setDocument(@Nonnull Document entity) {
        setDocumentPK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getDocumentPKHasBeenModified() {
        return _value.getDocumentPKHasBeenModified();
    }
    
    @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();
    }
    
}