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

/**
 * SequenceDetail.java
 */

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

import com.echothree.model.data.sequence.common.pk.SequenceDetailPK;

import com.echothree.model.data.sequence.common.pk.SequencePK;
import com.echothree.model.data.sequence.common.pk.SequenceTypePK;

import com.echothree.model.data.sequence.server.entity.Sequence;
import com.echothree.model.data.sequence.server.entity.SequenceType;

import com.echothree.model.data.sequence.server.factory.SequenceFactory;
import com.echothree.model.data.sequence.server.factory.SequenceTypeFactory;

import com.echothree.model.data.sequence.common.pk.SequenceDetailPK;

import com.echothree.model.data.sequence.server.value.SequenceDetailValue;

import com.echothree.model.data.sequence.server.factory.SequenceDetailFactory;

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 SequenceDetail
        extends BaseEntity
        implements Serializable {
    
    private SequenceDetailPK _pk;
    private SequenceDetailValue _value;
    
    /** Creates a new instance of SequenceDetail */
    public SequenceDetail()
            throws PersistenceException {
        super();
    }
    
    /** Creates a new instance of SequenceDetail */
    public SequenceDetail(SequenceDetailValue value, EntityPermission entityPermission) {
        super(entityPermission);
        
        _value = value;
        _pk = value.getPrimaryKey();
    }
    
    @Override
    @Nonnull
    public SequenceDetailFactory getBaseFactoryInstance() {
        return SequenceDetailFactory.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 SequenceDetail that) {
            SequenceDetailValue thatValue = that.getSequenceDetailValue();
            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 SequenceDetailValue getSequenceDetailValue() {
        return _value;
    }
    
    public void setSequenceDetailValue(@Nonnull SequenceDetailValue value)
            throws PersistenceReadOnlyException {
        checkReadWrite();
        _value = value;
    }
    
    @Override
    @Nonnull
    public SequenceDetailPK getPrimaryKey() {
        return _pk;
    }
    
    @Nonnull
    public SequencePK getSequencePK() {
        return _value.getSequencePK();
    }
    
    @Nonnull
    public Sequence getSequence(EntityPermission entityPermission) {
        return SequenceFactory.getInstance().getEntityFromPK(entityPermission, getSequencePK());
    }
    
    @Nonnull
    public Sequence getSequence() {
        return getSequence(EntityPermission.READ_ONLY);
    }
    
    @Nonnull
    public Sequence getSequenceForUpdate() {
        return getSequence(EntityPermission.READ_WRITE);
    }
    
    public void setSequencePK(@Nonnull SequencePK sequencePK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setSequencePK(sequencePK);
    }
    
    public void setSequence(@Nonnull Sequence entity) {
        setSequencePK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getSequencePKHasBeenModified() {
        return _value.getSequencePKHasBeenModified();
    }
    
    @Nonnull
    public SequenceTypePK getSequenceTypePK() {
        return _value.getSequenceTypePK();
    }
    
    @Nonnull
    public SequenceType getSequenceType(EntityPermission entityPermission) {
        return SequenceTypeFactory.getInstance().getEntityFromPK(entityPermission, getSequenceTypePK());
    }
    
    @Nonnull
    public SequenceType getSequenceType() {
        return getSequenceType(EntityPermission.READ_ONLY);
    }
    
    @Nonnull
    public SequenceType getSequenceTypeForUpdate() {
        return getSequenceType(EntityPermission.READ_WRITE);
    }
    
    public void setSequenceTypePK(@Nonnull SequenceTypePK sequenceTypePK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setSequenceTypePK(sequenceTypePK);
    }
    
    public void setSequenceType(@Nonnull SequenceType entity) {
        setSequenceTypePK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getSequenceTypePKHasBeenModified() {
        return _value.getSequenceTypePKHasBeenModified();
    }
    
    @Nonnull
    public String getSequenceName() {
        return _value.getSequenceName();
    }
    
    public void setSequenceName(@Nonnull String sequenceName)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setSequenceName(sequenceName);
    }
    
    public boolean getSequenceNameHasBeenModified() {
        return _value.getSequenceNameHasBeenModified();
    }
    
    @Nonnull
    public String getMask() {
        return _value.getMask();
    }
    
    public void setMask(@Nonnull String mask)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setMask(mask);
    }
    
    public boolean getMaskHasBeenModified() {
        return _value.getMaskHasBeenModified();
    }
    
    @Nullable
    public Integer getChunkSize() {
        return _value.getChunkSize();
    }
    
    public void setChunkSize(@Nullable Integer chunkSize)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setChunkSize(chunkSize);
    }
    
    public boolean getChunkSizeHasBeenModified() {
        return _value.getChunkSizeHasBeenModified();
    }
    
    @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();
    }
    
    @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();
    }
    
}