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

/**
 * PaymentMethodCreditCard.java
 */

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

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

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

import com.echothree.model.data.payment.server.entity.PaymentMethod;

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

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

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

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

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 PaymentMethodCreditCard
        extends BaseEntity
        implements Serializable {
    
    private PaymentMethodCreditCardPK _pk;
    private PaymentMethodCreditCardValue _value;
    
    /** Creates a new instance of PaymentMethodCreditCard */
    public PaymentMethodCreditCard()
            throws PersistenceException {
        super();
    }
    
    /** Creates a new instance of PaymentMethodCreditCard */
    public PaymentMethodCreditCard(PaymentMethodCreditCardValue value, EntityPermission entityPermission) {
        super(entityPermission);
        
        _value = value;
        _pk = value.getPrimaryKey();
    }
    
    @Override
    @Nonnull
    public PaymentMethodCreditCardFactory getBaseFactoryInstance() {
        return PaymentMethodCreditCardFactory.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 PaymentMethodCreditCard that) {
            PaymentMethodCreditCardValue thatValue = that.getPaymentMethodCreditCardValue();
            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 PaymentMethodCreditCardValue getPaymentMethodCreditCardValue() {
        return _value;
    }
    
    public void setPaymentMethodCreditCardValue(@Nonnull PaymentMethodCreditCardValue value)
            throws PersistenceReadOnlyException {
        checkReadWrite();
        _value = value;
    }
    
    @Override
    @Nonnull
    public PaymentMethodCreditCardPK 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 Boolean getRequestNameOnCard() {
        return _value.getRequestNameOnCard();
    }
    
    public void setRequestNameOnCard(@Nonnull Boolean requestNameOnCard)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setRequestNameOnCard(requestNameOnCard);
    }
    
    public boolean getRequestNameOnCardHasBeenModified() {
        return _value.getRequestNameOnCardHasBeenModified();
    }
    
    @Nonnull
    public Boolean getRequireNameOnCard() {
        return _value.getRequireNameOnCard();
    }
    
    public void setRequireNameOnCard(@Nonnull Boolean requireNameOnCard)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setRequireNameOnCard(requireNameOnCard);
    }
    
    public boolean getRequireNameOnCardHasBeenModified() {
        return _value.getRequireNameOnCardHasBeenModified();
    }
    
    @Nonnull
    public Boolean getCheckCardNumber() {
        return _value.getCheckCardNumber();
    }
    
    public void setCheckCardNumber(@Nonnull Boolean checkCardNumber)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setCheckCardNumber(checkCardNumber);
    }
    
    public boolean getCheckCardNumberHasBeenModified() {
        return _value.getCheckCardNumberHasBeenModified();
    }
    
    @Nonnull
    public Boolean getRequestExpirationDate() {
        return _value.getRequestExpirationDate();
    }
    
    public void setRequestExpirationDate(@Nonnull Boolean requestExpirationDate)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setRequestExpirationDate(requestExpirationDate);
    }
    
    public boolean getRequestExpirationDateHasBeenModified() {
        return _value.getRequestExpirationDateHasBeenModified();
    }
    
    @Nonnull
    public Boolean getRequireExpirationDate() {
        return _value.getRequireExpirationDate();
    }
    
    public void setRequireExpirationDate(@Nonnull Boolean requireExpirationDate)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setRequireExpirationDate(requireExpirationDate);
    }
    
    public boolean getRequireExpirationDateHasBeenModified() {
        return _value.getRequireExpirationDateHasBeenModified();
    }
    
    @Nonnull
    public Boolean getCheckExpirationDate() {
        return _value.getCheckExpirationDate();
    }
    
    public void setCheckExpirationDate(@Nonnull Boolean checkExpirationDate)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setCheckExpirationDate(checkExpirationDate);
    }
    
    public boolean getCheckExpirationDateHasBeenModified() {
        return _value.getCheckExpirationDateHasBeenModified();
    }
    
    @Nonnull
    public Boolean getRequestSecurityCode() {
        return _value.getRequestSecurityCode();
    }
    
    public void setRequestSecurityCode(@Nonnull Boolean requestSecurityCode)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setRequestSecurityCode(requestSecurityCode);
    }
    
    public boolean getRequestSecurityCodeHasBeenModified() {
        return _value.getRequestSecurityCodeHasBeenModified();
    }
    
    @Nonnull
    public Boolean getRequireSecurityCode() {
        return _value.getRequireSecurityCode();
    }
    
    public void setRequireSecurityCode(@Nonnull Boolean requireSecurityCode)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setRequireSecurityCode(requireSecurityCode);
    }
    
    public boolean getRequireSecurityCodeHasBeenModified() {
        return _value.getRequireSecurityCodeHasBeenModified();
    }
    
    @Nullable
    public String getCardNumberValidationPattern() {
        return _value.getCardNumberValidationPattern();
    }
    
    public void setCardNumberValidationPattern(@Nullable String cardNumberValidationPattern)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setCardNumberValidationPattern(cardNumberValidationPattern);
    }
    
    public boolean getCardNumberValidationPatternHasBeenModified() {
        return _value.getCardNumberValidationPatternHasBeenModified();
    }
    
    @Nullable
    public String getSecurityCodeValidationPattern() {
        return _value.getSecurityCodeValidationPattern();
    }
    
    public void setSecurityCodeValidationPattern(@Nullable String securityCodeValidationPattern)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setSecurityCodeValidationPattern(securityCodeValidationPattern);
    }
    
    public boolean getSecurityCodeValidationPatternHasBeenModified() {
        return _value.getSecurityCodeValidationPatternHasBeenModified();
    }
    
    @Nonnull
    public Boolean getRetainCreditCard() {
        return _value.getRetainCreditCard();
    }
    
    public void setRetainCreditCard(@Nonnull Boolean retainCreditCard)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setRetainCreditCard(retainCreditCard);
    }
    
    public boolean getRetainCreditCardHasBeenModified() {
        return _value.getRetainCreditCardHasBeenModified();
    }
    
    @Nonnull
    public Boolean getRetainSecurityCode() {
        return _value.getRetainSecurityCode();
    }
    
    public void setRetainSecurityCode(@Nonnull Boolean retainSecurityCode)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setRetainSecurityCode(retainSecurityCode);
    }
    
    public boolean getRetainSecurityCodeHasBeenModified() {
        return _value.getRetainSecurityCodeHasBeenModified();
    }
    
    @Nonnull
    public Boolean getRequestBilling() {
        return _value.getRequestBilling();
    }
    
    public void setRequestBilling(@Nonnull Boolean requestBilling)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setRequestBilling(requestBilling);
    }
    
    public boolean getRequestBillingHasBeenModified() {
        return _value.getRequestBillingHasBeenModified();
    }
    
    @Nonnull
    public Boolean getRequireBilling() {
        return _value.getRequireBilling();
    }
    
    public void setRequireBilling(@Nonnull Boolean requireBilling)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setRequireBilling(requireBilling);
    }
    
    public boolean getRequireBillingHasBeenModified() {
        return _value.getRequireBillingHasBeenModified();
    }
    
    @Nonnull
    public Boolean getRequestIssuer() {
        return _value.getRequestIssuer();
    }
    
    public void setRequestIssuer(@Nonnull Boolean requestIssuer)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setRequestIssuer(requestIssuer);
    }
    
    public boolean getRequestIssuerHasBeenModified() {
        return _value.getRequestIssuerHasBeenModified();
    }
    
    @Nonnull
    public Boolean getRequireIssuer() {
        return _value.getRequireIssuer();
    }
    
    public void setRequireIssuer(@Nonnull Boolean requireIssuer)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setRequireIssuer(requireIssuer);
    }
    
    public boolean getRequireIssuerHasBeenModified() {
        return _value.getRequireIssuerHasBeenModified();
    }
    
    @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();
    }
    
}