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

/**
 * WorkflowDetail.java
 */

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

import com.echothree.model.data.workflow.common.pk.WorkflowDetailPK;

import com.echothree.model.data.workflow.common.pk.WorkflowPK;
import com.echothree.model.data.selector.common.pk.SelectorTypePK;
import com.echothree.model.data.security.common.pk.SecurityRoleGroupPK;

import com.echothree.model.data.workflow.server.entity.Workflow;
import com.echothree.model.data.selector.server.entity.SelectorType;
import com.echothree.model.data.security.server.entity.SecurityRoleGroup;

import com.echothree.model.data.workflow.server.factory.WorkflowFactory;
import com.echothree.model.data.selector.server.factory.SelectorTypeFactory;
import com.echothree.model.data.security.server.factory.SecurityRoleGroupFactory;

import com.echothree.model.data.workflow.common.pk.WorkflowDetailPK;

import com.echothree.model.data.workflow.server.value.WorkflowDetailValue;

import com.echothree.model.data.workflow.server.factory.WorkflowDetailFactory;

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 WorkflowDetail
        extends BaseEntity
        implements Serializable {
    
    private WorkflowDetailPK _pk;
    private WorkflowDetailValue _value;
    
    /** Creates a new instance of WorkflowDetail */
    public WorkflowDetail()
            throws PersistenceException {
        super();
    }
    
    /** Creates a new instance of WorkflowDetail */
    public WorkflowDetail(WorkflowDetailValue value, EntityPermission entityPermission) {
        super(entityPermission);
        
        _value = value;
        _pk = value.getPrimaryKey();
    }
    
    @Override
    @Nonnull
    public WorkflowDetailFactory getBaseFactoryInstance() {
        return WorkflowDetailFactory.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 WorkflowDetail that) {
            WorkflowDetailValue thatValue = that.getWorkflowDetailValue();
            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 WorkflowDetailValue getWorkflowDetailValue() {
        return _value;
    }
    
    public void setWorkflowDetailValue(@Nonnull WorkflowDetailValue value)
            throws PersistenceReadOnlyException {
        checkReadWrite();
        _value = value;
    }
    
    @Override
    @Nonnull
    public WorkflowDetailPK getPrimaryKey() {
        return _pk;
    }
    
    @Nonnull
    public WorkflowPK getWorkflowPK() {
        return _value.getWorkflowPK();
    }
    
    @Nonnull
    public Workflow getWorkflow(EntityPermission entityPermission) {
        return WorkflowFactory.getInstance().getEntityFromPK(entityPermission, getWorkflowPK());
    }
    
    @Nonnull
    public Workflow getWorkflow() {
        return getWorkflow(EntityPermission.READ_ONLY);
    }
    
    @Nonnull
    public Workflow getWorkflowForUpdate() {
        return getWorkflow(EntityPermission.READ_WRITE);
    }
    
    public void setWorkflowPK(@Nonnull WorkflowPK workflowPK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setWorkflowPK(workflowPK);
    }
    
    public void setWorkflow(@Nonnull Workflow entity) {
        setWorkflowPK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getWorkflowPKHasBeenModified() {
        return _value.getWorkflowPKHasBeenModified();
    }
    
    @Nonnull
    public String getWorkflowName() {
        return _value.getWorkflowName();
    }
    
    public void setWorkflowName(@Nonnull String workflowName)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setWorkflowName(workflowName);
    }
    
    public boolean getWorkflowNameHasBeenModified() {
        return _value.getWorkflowNameHasBeenModified();
    }
    
    @Nullable
    public SelectorTypePK getSelectorTypePK() {
        return _value.getSelectorTypePK();
    }
    
    @Nullable
    public SelectorType getSelectorType(EntityPermission entityPermission) {
        SelectorTypePK pk = getSelectorTypePK();
        SelectorType entity = pk == null? null: SelectorTypeFactory.getInstance().getEntityFromPK(entityPermission, pk);
        
        return entity;
    }
    
    @Nullable
    public SelectorType getSelectorType() {
        return getSelectorType(EntityPermission.READ_ONLY);
    }
    
    @Nullable
    public SelectorType getSelectorTypeForUpdate() {
        return getSelectorType(EntityPermission.READ_WRITE);
    }
    
    public void setSelectorTypePK(@Nullable SelectorTypePK selectorTypePK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setSelectorTypePK(selectorTypePK);
    }
    
    public void setSelectorType(@Nullable SelectorType entity) {
        setSelectorTypePK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getSelectorTypePKHasBeenModified() {
        return _value.getSelectorTypePKHasBeenModified();
    }
    
    @Nullable
    public SecurityRoleGroupPK getSecurityRoleGroupPK() {
        return _value.getSecurityRoleGroupPK();
    }
    
    @Nullable
    public SecurityRoleGroup getSecurityRoleGroup(EntityPermission entityPermission) {
        SecurityRoleGroupPK pk = getSecurityRoleGroupPK();
        SecurityRoleGroup entity = pk == null? null: SecurityRoleGroupFactory.getInstance().getEntityFromPK(entityPermission, pk);
        
        return entity;
    }
    
    @Nullable
    public SecurityRoleGroup getSecurityRoleGroup() {
        return getSecurityRoleGroup(EntityPermission.READ_ONLY);
    }
    
    @Nullable
    public SecurityRoleGroup getSecurityRoleGroupForUpdate() {
        return getSecurityRoleGroup(EntityPermission.READ_WRITE);
    }
    
    public void setSecurityRoleGroupPK(@Nullable SecurityRoleGroupPK securityRoleGroupPK)
            throws PersistenceNotNullException, PersistenceReadOnlyException {
        checkReadWrite();
        _value.setSecurityRoleGroupPK(securityRoleGroupPK);
    }
    
    public void setSecurityRoleGroup(@Nullable SecurityRoleGroup entity) {
        setSecurityRoleGroupPK(entity == null ? null : entity.getPrimaryKey());
    }
    
    public boolean getSecurityRoleGroupPKHasBeenModified() {
        return _value.getSecurityRoleGroupPKHasBeenModified();
    }
    
    @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();
    }
    
}