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

/**
 * Currency.java
 */

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

import com.echothree.model.data.accounting.common.pk.CurrencyPK;

import com.echothree.model.data.accounting.common.pk.SymbolPositionPK;

import com.echothree.model.data.accounting.server.entity.SymbolPosition;

import com.echothree.model.data.accounting.server.factory.SymbolPositionFactory;

import com.echothree.model.data.accounting.common.pk.CurrencyPK;

import com.echothree.model.data.accounting.server.value.CurrencyValue;

import com.echothree.model.data.accounting.server.factory.CurrencyFactory;

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 Currency
        extends BaseEntity
        implements Serializable {
    
    private CurrencyPK _pk;
    private CurrencyValue _value;
    
    /** Creates a new instance of Currency */
    public Currency()
            throws PersistenceException {
        super();
    }
    
    /** Creates a new instance of Currency */
    public Currency(CurrencyValue value, EntityPermission entityPermission) {
        super(entityPermission);
        
        _value = value;
        _pk = value.getPrimaryKey();
    }
    
    @Override
    @Nonnull
    public CurrencyFactory getBaseFactoryInstance() {
        return CurrencyFactory.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 Currency that) {
            CurrencyValue thatValue = that.getCurrencyValue();
            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 CurrencyValue getCurrencyValue() {
        return _value;
    }
    
    public void setCurrencyValue(@Nonnull CurrencyValue value)
            throws PersistenceReadOnlyException {
        checkReadWrite();
        _value = value;
    }
    
    @Override
    @Nonnull
    public CurrencyPK getPrimaryKey() {
        return _pk;
    }
    
    @Nonnull
    public String getCurrencyIsoName() {
        return _value.getCurrencyIsoName();
    }
    
    public void setCurrencyIsoName(@Nonnull String currencyIsoName)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setCurrencyIsoName(currencyIsoName);
    }
    
    public boolean getCurrencyIsoNameHasBeenModified() {
        return _value.getCurrencyIsoNameHasBeenModified();
    }
    
    @Nullable
    public String getSymbol() {
        return _value.getSymbol();
    }
    
    public void setSymbol(@Nullable String symbol)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setSymbol(symbol);
    }
    
    public boolean getSymbolHasBeenModified() {
        return _value.getSymbolHasBeenModified();
    }
    
    @Nonnull
    public SymbolPositionPK getSymbolPositionPK() {
        return _value.getSymbolPositionPK();
    }
    
    @Nonnull
    public SymbolPosition getSymbolPosition(EntityPermission entityPermission) {
        return SymbolPositionFactory.getInstance().getEntityFromPK(entityPermission, getSymbolPositionPK());
    }
    
    @Nonnull
    public SymbolPosition getSymbolPosition() {
        return getSymbolPosition(EntityPermission.READ_ONLY);
    }
    
    @Nonnull
    public SymbolPosition getSymbolPositionForUpdate() {
        return getSymbolPosition(EntityPermission.READ_WRITE);
    }
    
    public void setSymbolPositionPK(@Nonnull SymbolPositionPK symbolPositionPK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setSymbolPositionPK(symbolPositionPK);
    }
    
    public void setSymbolPosition(@Nonnull SymbolPosition entity) {
        setSymbolPositionPK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getSymbolPositionPKHasBeenModified() {
        return _value.getSymbolPositionPKHasBeenModified();
    }
    
    @Nullable
    public Boolean getSymbolOnListStart() {
        return _value.getSymbolOnListStart();
    }
    
    public void setSymbolOnListStart(@Nullable Boolean symbolOnListStart)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setSymbolOnListStart(symbolOnListStart);
    }
    
    public boolean getSymbolOnListStartHasBeenModified() {
        return _value.getSymbolOnListStartHasBeenModified();
    }
    
    @Nullable
    public Boolean getSymbolOnListMember() {
        return _value.getSymbolOnListMember();
    }
    
    public void setSymbolOnListMember(@Nullable Boolean symbolOnListMember)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setSymbolOnListMember(symbolOnListMember);
    }
    
    public boolean getSymbolOnListMemberHasBeenModified() {
        return _value.getSymbolOnListMemberHasBeenModified();
    }
    
    @Nullable
    public Boolean getSymbolOnSubtotal() {
        return _value.getSymbolOnSubtotal();
    }
    
    public void setSymbolOnSubtotal(@Nullable Boolean symbolOnSubtotal)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setSymbolOnSubtotal(symbolOnSubtotal);
    }
    
    public boolean getSymbolOnSubtotalHasBeenModified() {
        return _value.getSymbolOnSubtotalHasBeenModified();
    }
    
    @Nullable
    public Boolean getSymbolOnTotal() {
        return _value.getSymbolOnTotal();
    }
    
    public void setSymbolOnTotal(@Nullable Boolean symbolOnTotal)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setSymbolOnTotal(symbolOnTotal);
    }
    
    public boolean getSymbolOnTotalHasBeenModified() {
        return _value.getSymbolOnTotalHasBeenModified();
    }
    
    @Nonnull
    public String getGroupingSeparator() {
        return _value.getGroupingSeparator();
    }
    
    public void setGroupingSeparator(@Nonnull String groupingSeparator)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setGroupingSeparator(groupingSeparator);
    }
    
    public boolean getGroupingSeparatorHasBeenModified() {
        return _value.getGroupingSeparatorHasBeenModified();
    }
    
    @Nonnull
    public Integer getGroupingSize() {
        return _value.getGroupingSize();
    }
    
    public void setGroupingSize(@Nonnull Integer groupingSize)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setGroupingSize(groupingSize);
    }
    
    public boolean getGroupingSizeHasBeenModified() {
        return _value.getGroupingSizeHasBeenModified();
    }
    
    @Nullable
    public String getFractionSeparator() {
        return _value.getFractionSeparator();
    }
    
    public void setFractionSeparator(@Nullable String fractionSeparator)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setFractionSeparator(fractionSeparator);
    }
    
    public boolean getFractionSeparatorHasBeenModified() {
        return _value.getFractionSeparatorHasBeenModified();
    }
    
    @Nullable
    public Integer getDefaultFractionDigits() {
        return _value.getDefaultFractionDigits();
    }
    
    public void setDefaultFractionDigits(@Nullable Integer defaultFractionDigits)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setDefaultFractionDigits(defaultFractionDigits);
    }
    
    public boolean getDefaultFractionDigitsHasBeenModified() {
        return _value.getDefaultFractionDigitsHasBeenModified();
    }
    
    @Nullable
    public Integer getPriceUnitFractionDigits() {
        return _value.getPriceUnitFractionDigits();
    }
    
    public void setPriceUnitFractionDigits(@Nullable Integer priceUnitFractionDigits)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setPriceUnitFractionDigits(priceUnitFractionDigits);
    }
    
    public boolean getPriceUnitFractionDigitsHasBeenModified() {
        return _value.getPriceUnitFractionDigitsHasBeenModified();
    }
    
    @Nullable
    public Integer getPriceLineFractionDigits() {
        return _value.getPriceLineFractionDigits();
    }
    
    public void setPriceLineFractionDigits(@Nullable Integer priceLineFractionDigits)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setPriceLineFractionDigits(priceLineFractionDigits);
    }
    
    public boolean getPriceLineFractionDigitsHasBeenModified() {
        return _value.getPriceLineFractionDigitsHasBeenModified();
    }
    
    @Nullable
    public Integer getCostUnitFractionDigits() {
        return _value.getCostUnitFractionDigits();
    }
    
    public void setCostUnitFractionDigits(@Nullable Integer costUnitFractionDigits)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setCostUnitFractionDigits(costUnitFractionDigits);
    }
    
    public boolean getCostUnitFractionDigitsHasBeenModified() {
        return _value.getCostUnitFractionDigitsHasBeenModified();
    }
    
    @Nullable
    public Integer getCostLineFractionDigits() {
        return _value.getCostLineFractionDigits();
    }
    
    public void setCostLineFractionDigits(@Nullable Integer costLineFractionDigits)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setCostLineFractionDigits(costLineFractionDigits);
    }
    
    public boolean getCostLineFractionDigitsHasBeenModified() {
        return _value.getCostLineFractionDigitsHasBeenModified();
    }
    
    @Nonnull
    public String getMinusSign() {
        return _value.getMinusSign();
    }
    
    public void setMinusSign(@Nonnull String minusSign)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setMinusSign(minusSign);
    }
    
    public boolean getMinusSignHasBeenModified() {
        return _value.getMinusSignHasBeenModified();
    }
    
    @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();
    }
    
}