001// --------------------------------------------------------------------------------
002// Copyright 2002-2026 Echo Three, LLC
003//
004// Licensed under the Apache License, Version 2.0 (the "License");
005// you may not use this file except in compliance with the License.
006// You may obtain a copy of the License at
007//
008//     http://www.apache.org/licenses/LICENSE-2.0
009//
010// Unless required by applicable law or agreed to in writing, software
011// distributed under the License is distributed on an "AS IS" BASIS,
012// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013// See the License for the specific language governing permissions and
014// limitations under the License.
015// --------------------------------------------------------------------------------
016
017package com.echothree.model.control.workflow.server.transfer;
018
019import javax.inject.Inject;
020import com.echothree.model.control.workflow.common.WorkflowProperties;
021import com.echothree.model.control.workflow.common.transfer.WorkflowEntranceTransfer;
022import com.echothree.model.control.workflow.server.control.WorkflowControl;
023import com.echothree.model.data.user.server.entity.UserVisit;
024import com.echothree.model.data.workflow.server.entity.WorkflowEntrance;
025import com.echothree.util.common.form.TransferProperties;
026import javax.enterprise.context.RequestScoped;
027
028@RequestScoped
029public class WorkflowEntranceTransferCache
030        extends BaseWorkflowTransferCache<WorkflowEntrance, WorkflowEntranceTransfer> {
031
032    @Inject
033    WorkflowControl workflowControl;
034
035    TransferProperties transferProperties;
036    boolean filterWorkflow;
037    boolean filterWorkflowEntranceName;
038    boolean filterIsDefault;
039    boolean filterSortOrder;
040    boolean filterDescription;
041    boolean filterEntityInstance;
042    
043    /** Creates a new instance of WorkflowEntranceTransferCache */
044    protected WorkflowEntranceTransferCache() {
045        super();
046        
047        transferProperties = session.getTransferProperties();
048        if(transferProperties != null) {
049            var properties = transferProperties.getProperties(WorkflowEntranceTransfer.class);
050            
051            if(properties != null) {
052                filterWorkflow = !properties.contains(WorkflowProperties.WORKFLOW);
053                filterWorkflowEntranceName = !properties.contains(WorkflowProperties.WORKFLOW_ENTRANCE_NAME);
054                filterIsDefault = !properties.contains(WorkflowProperties.IS_DEFAULT);
055                filterSortOrder = !properties.contains(WorkflowProperties.SORT_ORDER);
056                filterDescription = !properties.contains(WorkflowProperties.DESCRIPTION);
057                filterEntityInstance = !properties.contains(WorkflowProperties.ENTITY_INSTANCE);
058            }
059        }
060        
061        setIncludeEntityInstance(!filterEntityInstance);
062    }
063    
064    public WorkflowEntranceTransfer getWorkflowEntranceTransfer(UserVisit userVisit, WorkflowEntrance workflowEntrance) {
065        var workflowEntranceTransfer = get(workflowEntrance);
066        
067        if(workflowEntranceTransfer == null) {
068            var workflowEntranceDetail = workflowEntrance.getLastDetail();
069            var workflow = filterWorkflow ? null : workflowControl.getWorkflowTransfer(userVisit, workflowEntranceDetail.getWorkflow());
070            var workflowEntranceName = filterWorkflowEntranceName ? null : workflowEntranceDetail.getWorkflowEntranceName();
071            var isDefault = filterIsDefault ? null : workflowEntranceDetail.getIsDefault();
072            var sortOrder = filterSortOrder ? null : workflowEntranceDetail.getSortOrder();
073            var description = filterDescription ? null : workflowControl.getBestWorkflowEntranceDescription(workflowEntrance, getLanguage(userVisit));
074            
075            workflowEntranceTransfer = new WorkflowEntranceTransfer(workflow, workflowEntranceName, isDefault, sortOrder,
076                    description);
077            put(userVisit, workflowEntrance, workflowEntranceTransfer);
078        }
079        
080        return workflowEntranceTransfer;
081    }
082    
083}