// --------------------------------------------------------------------------------
// Copyright 2002-2024 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
// --------------------------------------------------------------------------------

/**
 * UseNameElementDetail.java
 */

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

import com.echothree.model.data.offer.common.pk.UseNameElementDetailPK;

import com.echothree.model.data.offer.common.pk.UseNameElementPK;

import com.echothree.model.data.offer.server.entity.UseNameElement;

import com.echothree.model.data.offer.server.factory.UseNameElementFactory;

import com.echothree.model.data.offer.common.pk.UseNameElementDetailPK;

import com.echothree.model.data.offer.server.value.UseNameElementDetailValue;

import com.echothree.model.data.offer.server.factory.UseNameElementDetailFactory;

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 UseNameElementDetail
        extends BaseEntity
        implements Serializable {
    
    private UseNameElementDetailPK _pk;
    private UseNameElementDetailValue _value;
    
    /** Creates a new instance of UseNameElementDetail */
    public UseNameElementDetail()
            throws PersistenceException {
        super();
    }
    
    /** Creates a new instance of UseNameElementDetail */
    public UseNameElementDetail(UseNameElementDetailValue value, EntityPermission entityPermission) {
        super(entityPermission);
        
        _value = value;
        _pk = value.getPrimaryKey();
    }
    
    @Override
    public UseNameElementDetailFactory getBaseFactoryInstance() {
        return UseNameElementDetailFactory.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 UseNameElementDetail) {
            UseNameElementDetail that = (UseNameElementDetail)other;
            
            UseNameElementDetailValue thatValue = that.getUseNameElementDetailValue();
            return _value.equals(thatValue);
        } else {
            return false;
        }
    }
    
    @Override
    public void store(Session session)
            throws PersistenceDatabaseException {
        getBaseFactoryInstance().store(session, this);
    }
    
    @Override
    public void remove(Session session)
            throws PersistenceDatabaseException {
        getBaseFactoryInstance().remove(session, this);
    }
    
    @Override
    public void remove()
            throws PersistenceDatabaseException {
        getBaseFactoryInstance().remove(ThreadSession.currentSession(), this);
    }
    
    public UseNameElementDetailValue getUseNameElementDetailValue() {
        return _value;
    }
    
    public void setUseNameElementDetailValue(UseNameElementDetailValue value)
            throws PersistenceReadOnlyException {
        checkReadWrite();
        _value = value;
    }
    
    @Override
    public UseNameElementDetailPK getPrimaryKey() {
        return _pk;
    }
    
    public UseNameElementPK getUseNameElementPK() {
        return _value.getUseNameElementPK();
    }
    
    public UseNameElement getUseNameElement(Session session, EntityPermission entityPermission) {
        return UseNameElementFactory.getInstance().getEntityFromPK(session, entityPermission, getUseNameElementPK());
    }
    
    public UseNameElement getUseNameElement(EntityPermission entityPermission) {
        return getUseNameElement(ThreadSession.currentSession(), entityPermission);
    }
    
    public UseNameElement getUseNameElement(Session session) {
        return getUseNameElement(session, EntityPermission.READ_ONLY);
    }
    
    public UseNameElement getUseNameElement() {
        return getUseNameElement(ThreadSession.currentSession(), EntityPermission.READ_ONLY);
    }
    
    public UseNameElement getUseNameElementForUpdate(Session session) {
        return getUseNameElement(session, EntityPermission.READ_WRITE);
    }
    
    public UseNameElement getUseNameElementForUpdate() {
        return getUseNameElement(ThreadSession.currentSession(), EntityPermission.READ_WRITE);
    }
    
    public void setUseNameElementPK(UseNameElementPK useNameElementPK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setUseNameElementPK(useNameElementPK);
    }
    
    public void setUseNameElement(UseNameElement entity) {
        setUseNameElementPK(entity == null? null: entity.getPrimaryKey());
    }
    
    public boolean getUseNameElementPKHasBeenModified() {
        return _value.getUseNameElementPKHasBeenModified();
    }
    
    public String getUseNameElementName() {
        return _value.getUseNameElementName();
    }
    
    public void setUseNameElementName(String useNameElementName)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setUseNameElementName(useNameElementName);
    }
    
    public boolean getUseNameElementNameHasBeenModified() {
        return _value.getUseNameElementNameHasBeenModified();
    }
    
    public Integer getOffset() {
        return _value.getOffset();
    }
    
    public void setOffset(Integer offset)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setOffset(offset);
    }
    
    public boolean getOffsetHasBeenModified() {
        return _value.getOffsetHasBeenModified();
    }
    
    public Integer getLength() {
        return _value.getLength();
    }
    
    public void setLength(Integer length)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setLength(length);
    }
    
    public boolean getLengthHasBeenModified() {
        return _value.getLengthHasBeenModified();
    }
    
    public String getValidationPattern() {
        return _value.getValidationPattern();
    }
    
    public void setValidationPattern(String validationPattern)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setValidationPattern(validationPattern);
    }
    
    public boolean getValidationPatternHasBeenModified() {
        return _value.getValidationPatternHasBeenModified();
    }
    
    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();
    }
    
}