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

/**
 * BatchAlias.java
 */

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

import com.echothree.model.data.batch.common.pk.BatchAliasPK;

import com.echothree.model.data.batch.common.pk.BatchPK;
import com.echothree.model.data.batch.common.pk.BatchAliasTypePK;

import com.echothree.model.data.batch.server.entity.Batch;
import com.echothree.model.data.batch.server.entity.BatchAliasType;

import com.echothree.model.data.batch.server.factory.BatchFactory;
import com.echothree.model.data.batch.server.factory.BatchAliasTypeFactory;

import com.echothree.model.data.batch.common.pk.BatchAliasPK;

import com.echothree.model.data.batch.server.value.BatchAliasValue;

import com.echothree.model.data.batch.server.factory.BatchAliasFactory;

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 BatchAlias
        extends BaseEntity
        implements Serializable {
    
    private BatchAliasPK _pk;
    private BatchAliasValue _value;
    
    /** Creates a new instance of BatchAlias */
    public BatchAlias()
            throws PersistenceException {
        super();
    }
    
    /** Creates a new instance of BatchAlias */
    public BatchAlias(BatchAliasValue value, EntityPermission entityPermission) {
        super(entityPermission);
        
        _value = value;
        _pk = value.getPrimaryKey();
    }
    
    @Override
    @Nonnull
    public BatchAliasFactory getBaseFactoryInstance() {
        return BatchAliasFactory.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 BatchAlias that) {
            BatchAliasValue thatValue = that.getBatchAliasValue();
            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 BatchAliasValue getBatchAliasValue() {
        return _value;
    }
    
    public void setBatchAliasValue(@Nonnull BatchAliasValue value)
            throws PersistenceReadOnlyException {
        checkReadWrite();
        _value = value;
    }
    
    @Override
    @Nonnull
    public BatchAliasPK getPrimaryKey() {
        return _pk;
    }
    
    @Nonnull
    public BatchPK getBatchPK() {
        return _value.getBatchPK();
    }
    
    @Nonnull
    public Batch getBatch(EntityPermission entityPermission) {
        return BatchFactory.getInstance().getEntityFromPK(entityPermission, getBatchPK());
    }
    
    @Nonnull
    public Batch getBatch() {
        return getBatch(EntityPermission.READ_ONLY);
    }
    
    @Nonnull
    public Batch getBatchForUpdate() {
        return getBatch(EntityPermission.READ_WRITE);
    }
    
    public void setBatchPK(@Nonnull BatchPK batchPK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setBatchPK(batchPK);
    }
    
    public void setBatch(@Nonnull Batch entity) {
        setBatchPK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getBatchPKHasBeenModified() {
        return _value.getBatchPKHasBeenModified();
    }
    
    @Nonnull
    public BatchAliasTypePK getBatchAliasTypePK() {
        return _value.getBatchAliasTypePK();
    }
    
    @Nonnull
    public BatchAliasType getBatchAliasType(EntityPermission entityPermission) {
        return BatchAliasTypeFactory.getInstance().getEntityFromPK(entityPermission, getBatchAliasTypePK());
    }
    
    @Nonnull
    public BatchAliasType getBatchAliasType() {
        return getBatchAliasType(EntityPermission.READ_ONLY);
    }
    
    @Nonnull
    public BatchAliasType getBatchAliasTypeForUpdate() {
        return getBatchAliasType(EntityPermission.READ_WRITE);
    }
    
    public void setBatchAliasTypePK(@Nonnull BatchAliasTypePK batchAliasTypePK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setBatchAliasTypePK(batchAliasTypePK);
    }
    
    public void setBatchAliasType(@Nonnull BatchAliasType entity) {
        setBatchAliasTypePK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getBatchAliasTypePKHasBeenModified() {
        return _value.getBatchAliasTypePKHasBeenModified();
    }
    
    @Nonnull
    public String getAlias() {
        return _value.getAlias();
    }
    
    public void setAlias(@Nonnull String alias)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setAlias(alias);
    }
    
    public boolean getAliasHasBeenModified() {
        return _value.getAliasHasBeenModified();
    }
    
    @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();
    }
    
}