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

/**
 * PostalAddressLineDetail.java
 */

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

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

import com.echothree.model.data.contact.common.pk.PostalAddressLinePK;
import com.echothree.model.data.contact.common.pk.PostalAddressFormatPK;

import com.echothree.model.data.contact.server.entity.PostalAddressLine;
import com.echothree.model.data.contact.server.entity.PostalAddressFormat;

import com.echothree.model.data.contact.server.factory.PostalAddressLineFactory;
import com.echothree.model.data.contact.server.factory.PostalAddressFormatFactory;

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

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

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

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 PostalAddressLineDetail
        extends BaseEntity
        implements Serializable {
    
    private PostalAddressLineDetailPK _pk;
    private PostalAddressLineDetailValue _value;
    
    /** Creates a new instance of PostalAddressLineDetail */
    public PostalAddressLineDetail()
            throws PersistenceException {
        super();
    }
    
    /** Creates a new instance of PostalAddressLineDetail */
    public PostalAddressLineDetail(PostalAddressLineDetailValue value, EntityPermission entityPermission) {
        super(entityPermission);
        
        _value = value;
        _pk = value.getPrimaryKey();
    }
    
    @Override
    @Nonnull
    public PostalAddressLineDetailFactory getBaseFactoryInstance() {
        return PostalAddressLineDetailFactory.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 PostalAddressLineDetail that) {
            PostalAddressLineDetailValue thatValue = that.getPostalAddressLineDetailValue();
            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 PostalAddressLineDetailValue getPostalAddressLineDetailValue() {
        return _value;
    }
    
    public void setPostalAddressLineDetailValue(@Nonnull PostalAddressLineDetailValue value)
            throws PersistenceReadOnlyException {
        checkReadWrite();
        _value = value;
    }
    
    @Override
    @Nonnull
    public PostalAddressLineDetailPK getPrimaryKey() {
        return _pk;
    }
    
    @Nonnull
    public PostalAddressLinePK getPostalAddressLinePK() {
        return _value.getPostalAddressLinePK();
    }
    
    @Nonnull
    public PostalAddressLine getPostalAddressLine(EntityPermission entityPermission) {
        return PostalAddressLineFactory.getInstance().getEntityFromPK(entityPermission, getPostalAddressLinePK());
    }
    
    @Nonnull
    public PostalAddressLine getPostalAddressLine() {
        return getPostalAddressLine(EntityPermission.READ_ONLY);
    }
    
    @Nonnull
    public PostalAddressLine getPostalAddressLineForUpdate() {
        return getPostalAddressLine(EntityPermission.READ_WRITE);
    }
    
    public void setPostalAddressLinePK(@Nonnull PostalAddressLinePK postalAddressLinePK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setPostalAddressLinePK(postalAddressLinePK);
    }
    
    public void setPostalAddressLine(@Nonnull PostalAddressLine entity) {
        setPostalAddressLinePK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getPostalAddressLinePKHasBeenModified() {
        return _value.getPostalAddressLinePKHasBeenModified();
    }
    
    @Nonnull
    public PostalAddressFormatPK getPostalAddressFormatPK() {
        return _value.getPostalAddressFormatPK();
    }
    
    @Nonnull
    public PostalAddressFormat getPostalAddressFormat(EntityPermission entityPermission) {
        return PostalAddressFormatFactory.getInstance().getEntityFromPK(entityPermission, getPostalAddressFormatPK());
    }
    
    @Nonnull
    public PostalAddressFormat getPostalAddressFormat() {
        return getPostalAddressFormat(EntityPermission.READ_ONLY);
    }
    
    @Nonnull
    public PostalAddressFormat getPostalAddressFormatForUpdate() {
        return getPostalAddressFormat(EntityPermission.READ_WRITE);
    }
    
    public void setPostalAddressFormatPK(@Nonnull PostalAddressFormatPK postalAddressFormatPK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setPostalAddressFormatPK(postalAddressFormatPK);
    }
    
    public void setPostalAddressFormat(@Nonnull PostalAddressFormat entity) {
        setPostalAddressFormatPK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getPostalAddressFormatPKHasBeenModified() {
        return _value.getPostalAddressFormatPKHasBeenModified();
    }
    
    @Nonnull
    public Integer getPostalAddressLineSortOrder() {
        return _value.getPostalAddressLineSortOrder();
    }
    
    public void setPostalAddressLineSortOrder(@Nonnull Integer postalAddressLineSortOrder)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setPostalAddressLineSortOrder(postalAddressLineSortOrder);
    }
    
    public boolean getPostalAddressLineSortOrderHasBeenModified() {
        return _value.getPostalAddressLineSortOrderHasBeenModified();
    }
    
    @Nullable
    public String getPrefix() {
        return _value.getPrefix();
    }
    
    public void setPrefix(@Nullable String prefix)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setPrefix(prefix);
    }
    
    public boolean getPrefixHasBeenModified() {
        return _value.getPrefixHasBeenModified();
    }
    
    @Nonnull
    public Boolean getAlwaysIncludePrefix() {
        return _value.getAlwaysIncludePrefix();
    }
    
    public void setAlwaysIncludePrefix(@Nonnull Boolean alwaysIncludePrefix)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setAlwaysIncludePrefix(alwaysIncludePrefix);
    }
    
    public boolean getAlwaysIncludePrefixHasBeenModified() {
        return _value.getAlwaysIncludePrefixHasBeenModified();
    }
    
    @Nullable
    public String getSuffix() {
        return _value.getSuffix();
    }
    
    public void setSuffix(@Nullable String suffix)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setSuffix(suffix);
    }
    
    public boolean getSuffixHasBeenModified() {
        return _value.getSuffixHasBeenModified();
    }
    
    @Nonnull
    public Boolean getAlwaysIncludeSuffix() {
        return _value.getAlwaysIncludeSuffix();
    }
    
    public void setAlwaysIncludeSuffix(@Nonnull Boolean alwaysIncludeSuffix)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setAlwaysIncludeSuffix(alwaysIncludeSuffix);
    }
    
    public boolean getAlwaysIncludeSuffixHasBeenModified() {
        return _value.getAlwaysIncludeSuffixHasBeenModified();
    }
    
    @Nonnull
    public Boolean getCollapseIfEmpty() {
        return _value.getCollapseIfEmpty();
    }
    
    public void setCollapseIfEmpty(@Nonnull Boolean collapseIfEmpty)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setCollapseIfEmpty(collapseIfEmpty);
    }
    
    public boolean getCollapseIfEmptyHasBeenModified() {
        return _value.getCollapseIfEmptyHasBeenModified();
    }
    
    @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();
    }
    
}