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

/**
 * ServiceDetail.java
 */

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

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

import com.echothree.model.data.core.common.pk.ServicePK;
import com.echothree.model.data.core.common.pk.ProtocolPK;

import com.echothree.model.data.core.server.entity.Service;
import com.echothree.model.data.core.server.entity.Protocol;

import com.echothree.model.data.core.server.factory.ServiceFactory;
import com.echothree.model.data.core.server.factory.ProtocolFactory;

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

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

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

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 ServiceDetail
        extends BaseEntity
        implements Serializable {
    
    private ServiceDetailPK _pk;
    private ServiceDetailValue _value;
    
    /** Creates a new instance of ServiceDetail */
    public ServiceDetail()
            throws PersistenceException {
        super();
    }
    
    /** Creates a new instance of ServiceDetail */
    public ServiceDetail(ServiceDetailValue value, EntityPermission entityPermission) {
        super(entityPermission);
        
        _value = value;
        _pk = value.getPrimaryKey();
    }
    
    @Override
    @Nonnull
    public ServiceDetailFactory getBaseFactoryInstance() {
        return ServiceDetailFactory.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 ServiceDetail that) {
            ServiceDetailValue thatValue = that.getServiceDetailValue();
            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 ServiceDetailValue getServiceDetailValue() {
        return _value;
    }
    
    public void setServiceDetailValue(@Nonnull ServiceDetailValue value)
            throws PersistenceReadOnlyException {
        checkReadWrite();
        _value = value;
    }
    
    @Override
    @Nonnull
    public ServiceDetailPK getPrimaryKey() {
        return _pk;
    }
    
    @Nonnull
    public ServicePK getServicePK() {
        return _value.getServicePK();
    }
    
    @Nonnull
    public Service getService(EntityPermission entityPermission) {
        return ServiceFactory.getInstance().getEntityFromPK(entityPermission, getServicePK());
    }
    
    @Nonnull
    public Service getService() {
        return getService(EntityPermission.READ_ONLY);
    }
    
    @Nonnull
    public Service getServiceForUpdate() {
        return getService(EntityPermission.READ_WRITE);
    }
    
    public void setServicePK(@Nonnull ServicePK servicePK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setServicePK(servicePK);
    }
    
    public void setService(@Nonnull Service entity) {
        setServicePK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getServicePKHasBeenModified() {
        return _value.getServicePKHasBeenModified();
    }
    
    @Nonnull
    public String getServiceName() {
        return _value.getServiceName();
    }
    
    public void setServiceName(@Nonnull String serviceName)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setServiceName(serviceName);
    }
    
    public boolean getServiceNameHasBeenModified() {
        return _value.getServiceNameHasBeenModified();
    }
    
    @Nonnull
    public Integer getPort() {
        return _value.getPort();
    }
    
    public void setPort(@Nonnull Integer port)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setPort(port);
    }
    
    public boolean getPortHasBeenModified() {
        return _value.getPortHasBeenModified();
    }
    
    @Nonnull
    public ProtocolPK getProtocolPK() {
        return _value.getProtocolPK();
    }
    
    @Nonnull
    public Protocol getProtocol(EntityPermission entityPermission) {
        return ProtocolFactory.getInstance().getEntityFromPK(entityPermission, getProtocolPK());
    }
    
    @Nonnull
    public Protocol getProtocol() {
        return getProtocol(EntityPermission.READ_ONLY);
    }
    
    @Nonnull
    public Protocol getProtocolForUpdate() {
        return getProtocol(EntityPermission.READ_WRITE);
    }
    
    public void setProtocolPK(@Nonnull ProtocolPK protocolPK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setProtocolPK(protocolPK);
    }
    
    public void setProtocol(@Nonnull Protocol entity) {
        setProtocolPK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getProtocolPKHasBeenModified() {
        return _value.getProtocolPKHasBeenModified();
    }
    
    @Nonnull
    public Boolean getIsDefault() {
        return _value.getIsDefault();
    }
    
    public void setIsDefault(@Nonnull Boolean isDefault)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setIsDefault(isDefault);
    }
    
    public boolean getIsDefaultHasBeenModified() {
        return _value.getIsDefaultHasBeenModified();
    }
    
    @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();
    }
    
}