001// --------------------------------------------------------------------------------
002// Copyright 2002-2025 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 com.echothree.model.control.workflow.common.WorkflowProperties;
020import com.echothree.model.control.workflow.common.transfer.WorkflowEntranceTransfer;
021import com.echothree.model.control.workflow.server.control.WorkflowControl;
022import com.echothree.model.data.user.server.entity.UserVisit;
023import com.echothree.model.data.workflow.server.entity.WorkflowEntrance;
024import com.echothree.util.common.form.TransferProperties;
025import com.echothree.util.server.persistence.Session;
026import javax.enterprise.context.RequestScoped;
027
028@RequestScoped
029public class WorkflowEntranceTransferCache
030        extends BaseWorkflowTransferCache<WorkflowEntrance, WorkflowEntranceTransfer> {
031
032    WorkflowControl workflowControl = Session.getModelController(WorkflowControl.class);
033
034    TransferProperties transferProperties;
035    boolean filterWorkflow;
036    boolean filterWorkflowEntranceName;
037    boolean filterIsDefault;
038    boolean filterSortOrder;
039    boolean filterDescription;
040    boolean filterEntityInstance;
041    
042    /** Creates a new instance of WorkflowEntranceTransferCache */
043    protected WorkflowEntranceTransferCache() {
044        super();
045        
046        transferProperties = session.getTransferProperties();
047        if(transferProperties != null) {
048            var properties = transferProperties.getProperties(WorkflowEntranceTransfer.class);
049            
050            if(properties != null) {
051                filterWorkflow = !properties.contains(WorkflowProperties.WORKFLOW);
052                filterWorkflowEntranceName = !properties.contains(WorkflowProperties.WORKFLOW_ENTRANCE_NAME);
053                filterIsDefault = !properties.contains(WorkflowProperties.IS_DEFAULT);
054                filterSortOrder = !properties.contains(WorkflowProperties.SORT_ORDER);
055                filterDescription = !properties.contains(WorkflowProperties.DESCRIPTION);
056                filterEntityInstance = !properties.contains(WorkflowProperties.ENTITY_INSTANCE);
057            }
058        }
059        
060        setIncludeEntityInstance(!filterEntityInstance);
061    }
062    
063    public WorkflowEntranceTransfer getWorkflowEntranceTransfer(UserVisit userVisit, WorkflowEntrance workflowEntrance) {
064        var workflowEntranceTransfer = get(workflowEntrance);
065        
066        if(workflowEntranceTransfer == null) {
067            var workflowEntranceDetail = workflowEntrance.getLastDetail();
068            var workflow = filterWorkflow ? null : workflowControl.getWorkflowTransfer(userVisit, workflowEntranceDetail.getWorkflow());
069            var workflowEntranceName = filterWorkflowEntranceName ? null : workflowEntranceDetail.getWorkflowEntranceName();
070            var isDefault = filterIsDefault ? null : workflowEntranceDetail.getIsDefault();
071            var sortOrder = filterSortOrder ? null : workflowEntranceDetail.getSortOrder();
072            var description = filterDescription ? null : workflowControl.getBestWorkflowEntranceDescription(workflowEntrance, getLanguage(userVisit));
073            
074            workflowEntranceTransfer = new WorkflowEntranceTransfer(workflow, workflowEntranceName, isDefault, sortOrder,
075                    description);
076            put(userVisit, workflowEntrance, workflowEntranceTransfer);
077        }
078        
079        return workflowEntranceTransfer;
080    }
081    
082}