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

/**
 * PaymentMethodDetail.java
 */

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

import com.echothree.model.data.payment.common.pk.PaymentMethodDetailPK;

import com.echothree.model.data.payment.common.pk.PaymentMethodPK;
import com.echothree.model.data.payment.common.pk.PaymentMethodTypePK;
import com.echothree.model.data.payment.common.pk.PaymentProcessorPK;
import com.echothree.model.data.selector.common.pk.SelectorPK;

import com.echothree.model.data.payment.server.entity.PaymentMethod;
import com.echothree.model.data.payment.server.entity.PaymentMethodType;
import com.echothree.model.data.payment.server.entity.PaymentProcessor;
import com.echothree.model.data.selector.server.entity.Selector;

import com.echothree.model.data.payment.server.factory.PaymentMethodFactory;
import com.echothree.model.data.payment.server.factory.PaymentMethodTypeFactory;
import com.echothree.model.data.payment.server.factory.PaymentProcessorFactory;
import com.echothree.model.data.selector.server.factory.SelectorFactory;

import com.echothree.model.data.payment.common.pk.PaymentMethodDetailPK;

import com.echothree.model.data.payment.server.value.PaymentMethodDetailValue;

import com.echothree.model.data.payment.server.factory.PaymentMethodDetailFactory;

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 PaymentMethodDetail
        extends BaseEntity
        implements Serializable {
    
    private PaymentMethodDetailPK _pk;
    private PaymentMethodDetailValue _value;
    
    /** Creates a new instance of PaymentMethodDetail */
    public PaymentMethodDetail()
            throws PersistenceException {
        super();
    }
    
    /** Creates a new instance of PaymentMethodDetail */
    public PaymentMethodDetail(PaymentMethodDetailValue value, EntityPermission entityPermission) {
        super(entityPermission);
        
        _value = value;
        _pk = value.getPrimaryKey();
    }
    
    @Override
    @Nonnull
    public PaymentMethodDetailFactory getBaseFactoryInstance() {
        return PaymentMethodDetailFactory.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 PaymentMethodDetail that) {
            PaymentMethodDetailValue thatValue = that.getPaymentMethodDetailValue();
            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 PaymentMethodDetailValue getPaymentMethodDetailValue() {
        return _value;
    }
    
    public void setPaymentMethodDetailValue(@Nonnull PaymentMethodDetailValue value)
            throws PersistenceReadOnlyException {
        checkReadWrite();
        _value = value;
    }
    
    @Override
    @Nonnull
    public PaymentMethodDetailPK getPrimaryKey() {
        return _pk;
    }
    
    @Nonnull
    public PaymentMethodPK getPaymentMethodPK() {
        return _value.getPaymentMethodPK();
    }
    
    @Nonnull
    public PaymentMethod getPaymentMethod(EntityPermission entityPermission) {
        return PaymentMethodFactory.getInstance().getEntityFromPK(entityPermission, getPaymentMethodPK());
    }
    
    @Nonnull
    public PaymentMethod getPaymentMethod() {
        return getPaymentMethod(EntityPermission.READ_ONLY);
    }
    
    @Nonnull
    public PaymentMethod getPaymentMethodForUpdate() {
        return getPaymentMethod(EntityPermission.READ_WRITE);
    }
    
    public void setPaymentMethodPK(@Nonnull PaymentMethodPK paymentMethodPK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setPaymentMethodPK(paymentMethodPK);
    }
    
    public void setPaymentMethod(@Nonnull PaymentMethod entity) {
        setPaymentMethodPK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getPaymentMethodPKHasBeenModified() {
        return _value.getPaymentMethodPKHasBeenModified();
    }
    
    @Nonnull
    public String getPaymentMethodName() {
        return _value.getPaymentMethodName();
    }
    
    public void setPaymentMethodName(@Nonnull String paymentMethodName)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setPaymentMethodName(paymentMethodName);
    }
    
    public boolean getPaymentMethodNameHasBeenModified() {
        return _value.getPaymentMethodNameHasBeenModified();
    }
    
    @Nonnull
    public PaymentMethodTypePK getPaymentMethodTypePK() {
        return _value.getPaymentMethodTypePK();
    }
    
    @Nonnull
    public PaymentMethodType getPaymentMethodType(EntityPermission entityPermission) {
        return PaymentMethodTypeFactory.getInstance().getEntityFromPK(entityPermission, getPaymentMethodTypePK());
    }
    
    @Nonnull
    public PaymentMethodType getPaymentMethodType() {
        return getPaymentMethodType(EntityPermission.READ_ONLY);
    }
    
    @Nonnull
    public PaymentMethodType getPaymentMethodTypeForUpdate() {
        return getPaymentMethodType(EntityPermission.READ_WRITE);
    }
    
    public void setPaymentMethodTypePK(@Nonnull PaymentMethodTypePK paymentMethodTypePK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setPaymentMethodTypePK(paymentMethodTypePK);
    }
    
    public void setPaymentMethodType(@Nonnull PaymentMethodType entity) {
        setPaymentMethodTypePK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getPaymentMethodTypePKHasBeenModified() {
        return _value.getPaymentMethodTypePKHasBeenModified();
    }
    
    @Nullable
    public PaymentProcessorPK getPaymentProcessorPK() {
        return _value.getPaymentProcessorPK();
    }
    
    @Nullable
    public PaymentProcessor getPaymentProcessor(EntityPermission entityPermission) {
        PaymentProcessorPK pk = getPaymentProcessorPK();
        PaymentProcessor entity = pk == null? null: PaymentProcessorFactory.getInstance().getEntityFromPK(entityPermission, pk);
        
        return entity;
    }
    
    @Nullable
    public PaymentProcessor getPaymentProcessor() {
        return getPaymentProcessor(EntityPermission.READ_ONLY);
    }
    
    @Nullable
    public PaymentProcessor getPaymentProcessorForUpdate() {
        return getPaymentProcessor(EntityPermission.READ_WRITE);
    }
    
    public void setPaymentProcessorPK(@Nullable PaymentProcessorPK paymentProcessorPK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setPaymentProcessorPK(paymentProcessorPK);
    }
    
    public void setPaymentProcessor(@Nullable PaymentProcessor entity) {
        setPaymentProcessorPK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getPaymentProcessorPKHasBeenModified() {
        return _value.getPaymentProcessorPKHasBeenModified();
    }
    
    @Nullable
    public SelectorPK getItemSelectorPK() {
        return _value.getItemSelectorPK();
    }
    
    @Nullable
    public Selector getItemSelector(EntityPermission entityPermission) {
        SelectorPK pk = getItemSelectorPK();
        Selector entity = pk == null? null: SelectorFactory.getInstance().getEntityFromPK(entityPermission, pk);
        
        return entity;
    }
    
    @Nullable
    public Selector getItemSelector() {
        return getItemSelector(EntityPermission.READ_ONLY);
    }
    
    @Nullable
    public Selector getItemSelectorForUpdate() {
        return getItemSelector(EntityPermission.READ_WRITE);
    }
    
    public void setItemSelectorPK(@Nullable SelectorPK itemSelectorPK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setItemSelectorPK(itemSelectorPK);
    }
    
    public void setItemSelector(@Nullable Selector entity) {
        setItemSelectorPK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getItemSelectorPKHasBeenModified() {
        return _value.getItemSelectorPKHasBeenModified();
    }
    
    @Nullable
    public SelectorPK getSalesOrderItemSelectorPK() {
        return _value.getSalesOrderItemSelectorPK();
    }
    
    @Nullable
    public Selector getSalesOrderItemSelector(EntityPermission entityPermission) {
        SelectorPK pk = getSalesOrderItemSelectorPK();
        Selector entity = pk == null? null: SelectorFactory.getInstance().getEntityFromPK(entityPermission, pk);
        
        return entity;
    }
    
    @Nullable
    public Selector getSalesOrderItemSelector() {
        return getSalesOrderItemSelector(EntityPermission.READ_ONLY);
    }
    
    @Nullable
    public Selector getSalesOrderItemSelectorForUpdate() {
        return getSalesOrderItemSelector(EntityPermission.READ_WRITE);
    }
    
    public void setSalesOrderItemSelectorPK(@Nullable SelectorPK salesOrderItemSelectorPK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setSalesOrderItemSelectorPK(salesOrderItemSelectorPK);
    }
    
    public void setSalesOrderItemSelector(@Nullable Selector entity) {
        setSalesOrderItemSelectorPK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getSalesOrderItemSelectorPKHasBeenModified() {
        return _value.getSalesOrderItemSelectorPKHasBeenModified();
    }
    
    @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();
    }
    
}