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

/**
 * SubscriptionDetail.java
 */

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

import com.echothree.model.data.subscription.common.pk.SubscriptionDetailPK;

import com.echothree.model.data.subscription.common.pk.SubscriptionPK;
import com.echothree.model.data.subscription.common.pk.SubscriptionTypePK;
import com.echothree.model.data.party.common.pk.PartyPK;

import com.echothree.model.data.subscription.server.entity.Subscription;
import com.echothree.model.data.subscription.server.entity.SubscriptionType;
import com.echothree.model.data.party.server.entity.Party;

import com.echothree.model.data.subscription.server.factory.SubscriptionFactory;
import com.echothree.model.data.subscription.server.factory.SubscriptionTypeFactory;
import com.echothree.model.data.party.server.factory.PartyFactory;

import com.echothree.model.data.subscription.common.pk.SubscriptionDetailPK;

import com.echothree.model.data.subscription.server.value.SubscriptionDetailValue;

import com.echothree.model.data.subscription.server.factory.SubscriptionDetailFactory;

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;

public class SubscriptionDetail
        extends BaseEntity
        implements Serializable {
    
    private SubscriptionDetailPK _pk;
    private SubscriptionDetailValue _value;
    
    /** Creates a new instance of SubscriptionDetail */
    public SubscriptionDetail()
            throws PersistenceException {
        super();
    }
    
    /** Creates a new instance of SubscriptionDetail */
    public SubscriptionDetail(SubscriptionDetailValue value, EntityPermission entityPermission) {
        super(entityPermission);
        
        _value = value;
        _pk = value.getPrimaryKey();
    }
    
    @Override
    public SubscriptionDetailFactory getBaseFactoryInstance() {
        return SubscriptionDetailFactory.getInstance();
    }
    
    @Override
    public boolean hasBeenModified() {
        return _value.hasBeenModified();
    }
    
    @Override
    public int hashCode() {
        return _pk.hashCode();
    }
    
    @Override
    public String toString() {
        return _pk.toString();
    }
    
    @Override
    public boolean equals(Object other) {
        if(this == other)
            return true;
        
        if(other instanceof SubscriptionDetail that) {
            SubscriptionDetailValue thatValue = that.getSubscriptionDetailValue();
            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);
    }
    
    public SubscriptionDetailValue getSubscriptionDetailValue() {
        return _value;
    }
    
    public void setSubscriptionDetailValue(SubscriptionDetailValue value)
            throws PersistenceReadOnlyException {
        checkReadWrite();
        _value = value;
    }
    
    @Override
    public SubscriptionDetailPK getPrimaryKey() {
        return _pk;
    }
    
    public SubscriptionPK getSubscriptionPK() {
        return _value.getSubscriptionPK();
    }
    
    public Subscription getSubscription(EntityPermission entityPermission) {
        return SubscriptionFactory.getInstance().getEntityFromPK(entityPermission, getSubscriptionPK());
    }
    
    public Subscription getSubscription() {
        return getSubscription(EntityPermission.READ_ONLY);
    }
    
    public Subscription getSubscriptionForUpdate() {
        return getSubscription(EntityPermission.READ_WRITE);
    }
    
    public void setSubscriptionPK(SubscriptionPK subscriptionPK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setSubscriptionPK(subscriptionPK);
    }
    
    public void setSubscription(Subscription entity) {
        setSubscriptionPK(entity == null? null: entity.getPrimaryKey());
    }
    
    public boolean getSubscriptionPKHasBeenModified() {
        return _value.getSubscriptionPKHasBeenModified();
    }
    
    public String getSubscriptionName() {
        return _value.getSubscriptionName();
    }
    
    public void setSubscriptionName(String subscriptionName)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setSubscriptionName(subscriptionName);
    }
    
    public boolean getSubscriptionNameHasBeenModified() {
        return _value.getSubscriptionNameHasBeenModified();
    }
    
    public SubscriptionTypePK getSubscriptionTypePK() {
        return _value.getSubscriptionTypePK();
    }
    
    public SubscriptionType getSubscriptionType(EntityPermission entityPermission) {
        return SubscriptionTypeFactory.getInstance().getEntityFromPK(entityPermission, getSubscriptionTypePK());
    }
    
    public SubscriptionType getSubscriptionType() {
        return getSubscriptionType(EntityPermission.READ_ONLY);
    }
    
    public SubscriptionType getSubscriptionTypeForUpdate() {
        return getSubscriptionType(EntityPermission.READ_WRITE);
    }
    
    public void setSubscriptionTypePK(SubscriptionTypePK subscriptionTypePK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setSubscriptionTypePK(subscriptionTypePK);
    }
    
    public void setSubscriptionType(SubscriptionType entity) {
        setSubscriptionTypePK(entity == null? null: entity.getPrimaryKey());
    }
    
    public boolean getSubscriptionTypePKHasBeenModified() {
        return _value.getSubscriptionTypePKHasBeenModified();
    }
    
    public PartyPK getPartyPK() {
        return _value.getPartyPK();
    }
    
    public Party getParty(EntityPermission entityPermission) {
        return PartyFactory.getInstance().getEntityFromPK(entityPermission, getPartyPK());
    }
    
    public Party getParty() {
        return getParty(EntityPermission.READ_ONLY);
    }
    
    public Party getPartyForUpdate() {
        return getParty(EntityPermission.READ_WRITE);
    }
    
    public void setPartyPK(PartyPK partyPK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setPartyPK(partyPK);
    }
    
    public void setParty(Party entity) {
        setPartyPK(entity == null? null: entity.getPrimaryKey());
    }
    
    public boolean getPartyPKHasBeenModified() {
        return _value.getPartyPKHasBeenModified();
    }
    
    public Long getStartTime() {
        return _value.getStartTime();
    }
    
    public void setStartTime(Long startTime)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setStartTime(startTime);
    }
    
    public boolean getStartTimeHasBeenModified() {
        return _value.getStartTimeHasBeenModified();
    }
    
    public Long getEndTime() {
        return _value.getEndTime();
    }
    
    public void setEndTime(Long endTime)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setEndTime(endTime);
    }
    
    public boolean getEndTimeHasBeenModified() {
        return _value.getEndTimeHasBeenModified();
    }
    
    public Long getFromTime() {
        return _value.getFromTime();
    }
    
    public void setFromTime(Long fromTime)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setFromTime(fromTime);
    }
    
    public boolean getFromTimeHasBeenModified() {
        return _value.getFromTimeHasBeenModified();
    }
    
    public Long getThruTime() {
        return _value.getThruTime();
    }
    
    public void setThruTime(Long thruTime)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setThruTime(thruTime);
    }
    
    public boolean getThruTimeHasBeenModified() {
        return _value.getThruTimeHasBeenModified();
    }
    
}