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

/**
 * VendorItemDetail.java
 */

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

import com.echothree.model.data.vendor.common.pk.VendorItemDetailPK;

import com.echothree.model.data.vendor.common.pk.VendorItemPK;
import com.echothree.model.data.item.common.pk.ItemPK;
import com.echothree.model.data.party.common.pk.PartyPK;
import com.echothree.model.data.cancellationpolicy.common.pk.CancellationPolicyPK;
import com.echothree.model.data.returnpolicy.common.pk.ReturnPolicyPK;

import com.echothree.model.data.vendor.server.entity.VendorItem;
import com.echothree.model.data.item.server.entity.Item;
import com.echothree.model.data.party.server.entity.Party;
import com.echothree.model.data.cancellationpolicy.server.entity.CancellationPolicy;
import com.echothree.model.data.returnpolicy.server.entity.ReturnPolicy;

import com.echothree.model.data.vendor.server.factory.VendorItemFactory;
import com.echothree.model.data.item.server.factory.ItemFactory;
import com.echothree.model.data.party.server.factory.PartyFactory;
import com.echothree.model.data.cancellationpolicy.server.factory.CancellationPolicyFactory;
import com.echothree.model.data.returnpolicy.server.factory.ReturnPolicyFactory;

import com.echothree.model.data.vendor.common.pk.VendorItemDetailPK;

import com.echothree.model.data.vendor.server.value.VendorItemDetailValue;

import com.echothree.model.data.vendor.server.factory.VendorItemDetailFactory;

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 VendorItemDetail
        extends BaseEntity
        implements Serializable {
    
    private VendorItemDetailPK _pk;
    private VendorItemDetailValue _value;
    
    /** Creates a new instance of VendorItemDetail */
    public VendorItemDetail()
            throws PersistenceException {
        super();
    }
    
    /** Creates a new instance of VendorItemDetail */
    public VendorItemDetail(VendorItemDetailValue value, EntityPermission entityPermission) {
        super(entityPermission);
        
        _value = value;
        _pk = value.getPrimaryKey();
    }
    
    @Override
    @Nonnull
    public VendorItemDetailFactory getBaseFactoryInstance() {
        return VendorItemDetailFactory.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 VendorItemDetail that) {
            VendorItemDetailValue thatValue = that.getVendorItemDetailValue();
            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 VendorItemDetailValue getVendorItemDetailValue() {
        return _value;
    }
    
    public void setVendorItemDetailValue(@Nonnull VendorItemDetailValue value)
            throws PersistenceReadOnlyException {
        checkReadWrite();
        _value = value;
    }
    
    @Override
    @Nonnull
    public VendorItemDetailPK getPrimaryKey() {
        return _pk;
    }
    
    @Nonnull
    public VendorItemPK getVendorItemPK() {
        return _value.getVendorItemPK();
    }
    
    @Nonnull
    public VendorItem getVendorItem(EntityPermission entityPermission) {
        return VendorItemFactory.getInstance().getEntityFromPK(entityPermission, getVendorItemPK());
    }
    
    @Nonnull
    public VendorItem getVendorItem() {
        return getVendorItem(EntityPermission.READ_ONLY);
    }
    
    @Nonnull
    public VendorItem getVendorItemForUpdate() {
        return getVendorItem(EntityPermission.READ_WRITE);
    }
    
    public void setVendorItemPK(@Nonnull VendorItemPK vendorItemPK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setVendorItemPK(vendorItemPK);
    }
    
    public void setVendorItem(@Nonnull VendorItem entity) {
        setVendorItemPK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getVendorItemPKHasBeenModified() {
        return _value.getVendorItemPKHasBeenModified();
    }
    
    @Nonnull
    public ItemPK getItemPK() {
        return _value.getItemPK();
    }
    
    @Nonnull
    public Item getItem(EntityPermission entityPermission) {
        return ItemFactory.getInstance().getEntityFromPK(entityPermission, getItemPK());
    }
    
    @Nonnull
    public Item getItem() {
        return getItem(EntityPermission.READ_ONLY);
    }
    
    @Nonnull
    public Item getItemForUpdate() {
        return getItem(EntityPermission.READ_WRITE);
    }
    
    public void setItemPK(@Nonnull ItemPK itemPK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setItemPK(itemPK);
    }
    
    public void setItem(@Nonnull Item entity) {
        setItemPK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getItemPKHasBeenModified() {
        return _value.getItemPKHasBeenModified();
    }
    
    @Nonnull
    public PartyPK getVendorPartyPK() {
        return _value.getVendorPartyPK();
    }
    
    @Nonnull
    public Party getVendorParty(EntityPermission entityPermission) {
        return PartyFactory.getInstance().getEntityFromPK(entityPermission, getVendorPartyPK());
    }
    
    @Nonnull
    public Party getVendorParty() {
        return getVendorParty(EntityPermission.READ_ONLY);
    }
    
    @Nonnull
    public Party getVendorPartyForUpdate() {
        return getVendorParty(EntityPermission.READ_WRITE);
    }
    
    public void setVendorPartyPK(@Nonnull PartyPK vendorPartyPK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setVendorPartyPK(vendorPartyPK);
    }
    
    public void setVendorParty(@Nonnull Party entity) {
        setVendorPartyPK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getVendorPartyPKHasBeenModified() {
        return _value.getVendorPartyPKHasBeenModified();
    }
    
    @Nonnull
    public String getVendorItemName() {
        return _value.getVendorItemName();
    }
    
    public void setVendorItemName(@Nonnull String vendorItemName)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setVendorItemName(vendorItemName);
    }
    
    public boolean getVendorItemNameHasBeenModified() {
        return _value.getVendorItemNameHasBeenModified();
    }
    
    @Nullable
    public String getDescription() {
        return _value.getDescription();
    }
    
    public void setDescription(@Nullable String description)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setDescription(description);
    }
    
    public boolean getDescriptionHasBeenModified() {
        return _value.getDescriptionHasBeenModified();
    }
    
    @Nonnull
    public Integer getPriority() {
        return _value.getPriority();
    }
    
    public void setPriority(@Nonnull Integer priority)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setPriority(priority);
    }
    
    public boolean getPriorityHasBeenModified() {
        return _value.getPriorityHasBeenModified();
    }
    
    @Nullable
    public CancellationPolicyPK getCancellationPolicyPK() {
        return _value.getCancellationPolicyPK();
    }
    
    @Nullable
    public CancellationPolicy getCancellationPolicy(EntityPermission entityPermission) {
        CancellationPolicyPK pk = getCancellationPolicyPK();
        CancellationPolicy entity = pk == null? null: CancellationPolicyFactory.getInstance().getEntityFromPK(entityPermission, pk);
        
        return entity;
    }
    
    @Nullable
    public CancellationPolicy getCancellationPolicy() {
        return getCancellationPolicy(EntityPermission.READ_ONLY);
    }
    
    @Nullable
    public CancellationPolicy getCancellationPolicyForUpdate() {
        return getCancellationPolicy(EntityPermission.READ_WRITE);
    }
    
    public void setCancellationPolicyPK(@Nullable CancellationPolicyPK cancellationPolicyPK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setCancellationPolicyPK(cancellationPolicyPK);
    }
    
    public void setCancellationPolicy(@Nullable CancellationPolicy entity) {
        setCancellationPolicyPK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getCancellationPolicyPKHasBeenModified() {
        return _value.getCancellationPolicyPKHasBeenModified();
    }
    
    @Nullable
    public ReturnPolicyPK getReturnPolicyPK() {
        return _value.getReturnPolicyPK();
    }
    
    @Nullable
    public ReturnPolicy getReturnPolicy(EntityPermission entityPermission) {
        ReturnPolicyPK pk = getReturnPolicyPK();
        ReturnPolicy entity = pk == null? null: ReturnPolicyFactory.getInstance().getEntityFromPK(entityPermission, pk);
        
        return entity;
    }
    
    @Nullable
    public ReturnPolicy getReturnPolicy() {
        return getReturnPolicy(EntityPermission.READ_ONLY);
    }
    
    @Nullable
    public ReturnPolicy getReturnPolicyForUpdate() {
        return getReturnPolicy(EntityPermission.READ_WRITE);
    }
    
    public void setReturnPolicyPK(@Nullable ReturnPolicyPK returnPolicyPK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setReturnPolicyPK(returnPolicyPK);
    }
    
    public void setReturnPolicy(@Nullable ReturnPolicy entity) {
        setReturnPolicyPK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getReturnPolicyPKHasBeenModified() {
        return _value.getReturnPolicyPKHasBeenModified();
    }
    
    @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();
    }
    
}