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

/**
 * ContactMechanismDetail.java
 */

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

import com.echothree.model.data.contact.common.pk.ContactMechanismDetailPK;

import com.echothree.model.data.contact.common.pk.ContactMechanismPK;
import com.echothree.model.data.contact.common.pk.ContactMechanismTypePK;

import com.echothree.model.data.contact.server.entity.ContactMechanism;
import com.echothree.model.data.contact.server.entity.ContactMechanismType;

import com.echothree.model.data.contact.server.factory.ContactMechanismFactory;
import com.echothree.model.data.contact.server.factory.ContactMechanismTypeFactory;

import com.echothree.model.data.contact.common.pk.ContactMechanismDetailPK;

import com.echothree.model.data.contact.server.value.ContactMechanismDetailValue;

import com.echothree.model.data.contact.server.factory.ContactMechanismDetailFactory;

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 ContactMechanismDetail
        extends BaseEntity
        implements Serializable {
    
    private ContactMechanismDetailPK _pk;
    private ContactMechanismDetailValue _value;
    
    /** Creates a new instance of ContactMechanismDetail */
    public ContactMechanismDetail()
            throws PersistenceException {
        super();
    }
    
    /** Creates a new instance of ContactMechanismDetail */
    public ContactMechanismDetail(ContactMechanismDetailValue value, EntityPermission entityPermission) {
        super(entityPermission);
        
        _value = value;
        _pk = value.getPrimaryKey();
    }
    
    @Override
    @Nonnull
    public ContactMechanismDetailFactory getBaseFactoryInstance() {
        return ContactMechanismDetailFactory.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 ContactMechanismDetail that) {
            ContactMechanismDetailValue thatValue = that.getContactMechanismDetailValue();
            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 ContactMechanismDetailValue getContactMechanismDetailValue() {
        return _value;
    }
    
    public void setContactMechanismDetailValue(@Nonnull ContactMechanismDetailValue value)
            throws PersistenceReadOnlyException {
        checkReadWrite();
        _value = value;
    }
    
    @Override
    @Nonnull
    public ContactMechanismDetailPK getPrimaryKey() {
        return _pk;
    }
    
    @Nonnull
    public ContactMechanismPK getContactMechanismPK() {
        return _value.getContactMechanismPK();
    }
    
    @Nonnull
    public ContactMechanism getContactMechanism(EntityPermission entityPermission) {
        return ContactMechanismFactory.getInstance().getEntityFromPK(entityPermission, getContactMechanismPK());
    }
    
    @Nonnull
    public ContactMechanism getContactMechanism() {
        return getContactMechanism(EntityPermission.READ_ONLY);
    }
    
    @Nonnull
    public ContactMechanism getContactMechanismForUpdate() {
        return getContactMechanism(EntityPermission.READ_WRITE);
    }
    
    public void setContactMechanismPK(@Nonnull ContactMechanismPK contactMechanismPK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setContactMechanismPK(contactMechanismPK);
    }
    
    public void setContactMechanism(@Nonnull ContactMechanism entity) {
        setContactMechanismPK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getContactMechanismPKHasBeenModified() {
        return _value.getContactMechanismPKHasBeenModified();
    }
    
    @Nonnull
    public String getContactMechanismName() {
        return _value.getContactMechanismName();
    }
    
    public void setContactMechanismName(@Nonnull String contactMechanismName)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setContactMechanismName(contactMechanismName);
    }
    
    public boolean getContactMechanismNameHasBeenModified() {
        return _value.getContactMechanismNameHasBeenModified();
    }
    
    @Nonnull
    public ContactMechanismTypePK getContactMechanismTypePK() {
        return _value.getContactMechanismTypePK();
    }
    
    @Nonnull
    public ContactMechanismType getContactMechanismType(EntityPermission entityPermission) {
        return ContactMechanismTypeFactory.getInstance().getEntityFromPK(entityPermission, getContactMechanismTypePK());
    }
    
    @Nonnull
    public ContactMechanismType getContactMechanismType() {
        return getContactMechanismType(EntityPermission.READ_ONLY);
    }
    
    @Nonnull
    public ContactMechanismType getContactMechanismTypeForUpdate() {
        return getContactMechanismType(EntityPermission.READ_WRITE);
    }
    
    public void setContactMechanismTypePK(@Nonnull ContactMechanismTypePK contactMechanismTypePK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setContactMechanismTypePK(contactMechanismTypePK);
    }
    
    public void setContactMechanismType(@Nonnull ContactMechanismType entity) {
        setContactMechanismTypePK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getContactMechanismTypePKHasBeenModified() {
        return _value.getContactMechanismTypePKHasBeenModified();
    }
    
    @Nonnull
    public Boolean getAllowSolicitation() {
        return _value.getAllowSolicitation();
    }
    
    public void setAllowSolicitation(@Nonnull Boolean allowSolicitation)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setAllowSolicitation(allowSolicitation);
    }
    
    public boolean getAllowSolicitationHasBeenModified() {
        return _value.getAllowSolicitationHasBeenModified();
    }
    
    @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();
    }
    
}