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

/**
 * CommunicationEmailSource.java
 */

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

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

import com.echothree.model.data.communication.common.pk.CommunicationSourcePK;
import com.echothree.model.data.core.common.pk.ServerPK;
import com.echothree.model.data.workeffort.common.pk.WorkEffortScopePK;
import com.echothree.model.data.selector.common.pk.SelectorPK;

import com.echothree.model.data.communication.server.entity.CommunicationSource;
import com.echothree.model.data.core.server.entity.Server;
import com.echothree.model.data.workeffort.server.entity.WorkEffortScope;
import com.echothree.model.data.selector.server.entity.Selector;

import com.echothree.model.data.communication.server.factory.CommunicationSourceFactory;
import com.echothree.model.data.core.server.factory.ServerFactory;
import com.echothree.model.data.workeffort.server.factory.WorkEffortScopeFactory;
import com.echothree.model.data.selector.server.factory.SelectorFactory;

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

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

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

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;

public class CommunicationEmailSource
        extends BaseEntity
        implements Serializable {
    
    private CommunicationEmailSourcePK _pk;
    private CommunicationEmailSourceValue _value;
    
    /** Creates a new instance of CommunicationEmailSource */
    public CommunicationEmailSource()
            throws PersistenceException {
        super();
    }
    
    /** Creates a new instance of CommunicationEmailSource */
    public CommunicationEmailSource(CommunicationEmailSourceValue value, EntityPermission entityPermission) {
        super(entityPermission);
        
        _value = value;
        _pk = value.getPrimaryKey();
    }
    
    @Override
    public CommunicationEmailSourceFactory getBaseFactoryInstance() {
        return CommunicationEmailSourceFactory.getInstance();
    }
    
    @Override
    public boolean hasBeenModified() {
        return _value.hasBeenModified();
    }
    
    @Override
    public int hashCode() {
        return _pk.hashCode();
    }
    
    @Override
    public String toString() {
        return _pk.toString();
    }
    
    @Override
    public boolean equals(Object other) {
        if(this == other)
            return true;
        
        if(other instanceof CommunicationEmailSource that) {
            CommunicationEmailSourceValue thatValue = that.getCommunicationEmailSourceValue();
            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);
    }
    
    public CommunicationEmailSourceValue getCommunicationEmailSourceValue() {
        return _value;
    }
    
    public void setCommunicationEmailSourceValue(CommunicationEmailSourceValue value)
            throws PersistenceReadOnlyException {
        checkReadWrite();
        _value = value;
    }
    
    @Override
    public CommunicationEmailSourcePK getPrimaryKey() {
        return _pk;
    }
    
    public CommunicationSourcePK getCommunicationSourcePK() {
        return _value.getCommunicationSourcePK();
    }
    
    public CommunicationSource getCommunicationSource(EntityPermission entityPermission) {
        return CommunicationSourceFactory.getInstance().getEntityFromPK(entityPermission, getCommunicationSourcePK());
    }
    
    public CommunicationSource getCommunicationSource() {
        return getCommunicationSource(EntityPermission.READ_ONLY);
    }
    
    public CommunicationSource getCommunicationSourceForUpdate() {
        return getCommunicationSource(EntityPermission.READ_WRITE);
    }
    
    public void setCommunicationSourcePK(CommunicationSourcePK communicationSourcePK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setCommunicationSourcePK(communicationSourcePK);
    }
    
    public void setCommunicationSource(CommunicationSource entity) {
        setCommunicationSourcePK(entity == null? null: entity.getPrimaryKey());
    }
    
    public boolean getCommunicationSourcePKHasBeenModified() {
        return _value.getCommunicationSourcePKHasBeenModified();
    }
    
    public ServerPK getServerPK() {
        return _value.getServerPK();
    }
    
    public Server getServer(EntityPermission entityPermission) {
        return ServerFactory.getInstance().getEntityFromPK(entityPermission, getServerPK());
    }
    
    public Server getServer() {
        return getServer(EntityPermission.READ_ONLY);
    }
    
    public Server getServerForUpdate() {
        return getServer(EntityPermission.READ_WRITE);
    }
    
    public void setServerPK(ServerPK serverPK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setServerPK(serverPK);
    }
    
    public void setServer(Server entity) {
        setServerPK(entity == null? null: entity.getPrimaryKey());
    }
    
    public boolean getServerPKHasBeenModified() {
        return _value.getServerPKHasBeenModified();
    }
    
    public String getUsername() {
        return _value.getUsername();
    }
    
    public void setUsername(String username)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setUsername(username);
    }
    
    public boolean getUsernameHasBeenModified() {
        return _value.getUsernameHasBeenModified();
    }
    
    public String getPassword() {
        return _value.getPassword();
    }
    
    public void setPassword(String password)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setPassword(password);
    }
    
    public boolean getPasswordHasBeenModified() {
        return _value.getPasswordHasBeenModified();
    }
    
    public WorkEffortScopePK getReceiveWorkEffortScopePK() {
        return _value.getReceiveWorkEffortScopePK();
    }
    
    public WorkEffortScope getReceiveWorkEffortScope(EntityPermission entityPermission) {
        return WorkEffortScopeFactory.getInstance().getEntityFromPK(entityPermission, getReceiveWorkEffortScopePK());
    }
    
    public WorkEffortScope getReceiveWorkEffortScope() {
        return getReceiveWorkEffortScope(EntityPermission.READ_ONLY);
    }
    
    public WorkEffortScope getReceiveWorkEffortScopeForUpdate() {
        return getReceiveWorkEffortScope(EntityPermission.READ_WRITE);
    }
    
    public void setReceiveWorkEffortScopePK(WorkEffortScopePK receiveWorkEffortScopePK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setReceiveWorkEffortScopePK(receiveWorkEffortScopePK);
    }
    
    public void setReceiveWorkEffortScope(WorkEffortScope entity) {
        setReceiveWorkEffortScopePK(entity == null? null: entity.getPrimaryKey());
    }
    
    public boolean getReceiveWorkEffortScopePKHasBeenModified() {
        return _value.getReceiveWorkEffortScopePKHasBeenModified();
    }
    
    public WorkEffortScopePK getSendWorkEffortScopePK() {
        return _value.getSendWorkEffortScopePK();
    }
    
    public WorkEffortScope getSendWorkEffortScope(EntityPermission entityPermission) {
        return WorkEffortScopeFactory.getInstance().getEntityFromPK(entityPermission, getSendWorkEffortScopePK());
    }
    
    public WorkEffortScope getSendWorkEffortScope() {
        return getSendWorkEffortScope(EntityPermission.READ_ONLY);
    }
    
    public WorkEffortScope getSendWorkEffortScopeForUpdate() {
        return getSendWorkEffortScope(EntityPermission.READ_WRITE);
    }
    
    public void setSendWorkEffortScopePK(WorkEffortScopePK sendWorkEffortScopePK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setSendWorkEffortScopePK(sendWorkEffortScopePK);
    }
    
    public void setSendWorkEffortScope(WorkEffortScope entity) {
        setSendWorkEffortScopePK(entity == null? null: entity.getPrimaryKey());
    }
    
    public boolean getSendWorkEffortScopePKHasBeenModified() {
        return _value.getSendWorkEffortScopePKHasBeenModified();
    }
    
    public SelectorPK getReviewEmployeeSelectorPK() {
        return _value.getReviewEmployeeSelectorPK();
    }
    
    public Selector getReviewEmployeeSelector(EntityPermission entityPermission) {
        SelectorPK pk = getReviewEmployeeSelectorPK();
        Selector entity = pk == null? null: SelectorFactory.getInstance().getEntityFromPK(entityPermission, pk);
        
        return entity;
    }
    
    public Selector getReviewEmployeeSelector() {
        return getReviewEmployeeSelector(EntityPermission.READ_ONLY);
    }
    
    public Selector getReviewEmployeeSelectorForUpdate() {
        return getReviewEmployeeSelector(EntityPermission.READ_WRITE);
    }
    
    public void setReviewEmployeeSelectorPK(SelectorPK reviewEmployeeSelectorPK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setReviewEmployeeSelectorPK(reviewEmployeeSelectorPK);
    }
    
    public void setReviewEmployeeSelector(Selector entity) {
        setReviewEmployeeSelectorPK(entity == null? null: entity.getPrimaryKey());
    }
    
    public boolean getReviewEmployeeSelectorPKHasBeenModified() {
        return _value.getReviewEmployeeSelectorPKHasBeenModified();
    }
    
    public Long getFromTime() {
        return _value.getFromTime();
    }
    
    public void setFromTime(Long fromTime)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setFromTime(fromTime);
    }
    
    public boolean getFromTimeHasBeenModified() {
        return _value.getFromTimeHasBeenModified();
    }
    
    public Long getThruTime() {
        return _value.getThruTime();
    }
    
    public void setThruTime(Long thruTime)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setThruTime(thruTime);
    }
    
    public boolean getThruTimeHasBeenModified() {
        return _value.getThruTimeHasBeenModified();
    }
    
}