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.WorkflowDestinationTransfer;
022import com.echothree.model.control.workflow.common.transfer.WorkflowEntranceTransfer;
023import com.echothree.model.control.workflow.server.control.WorkflowControl;
024import com.echothree.model.data.user.server.entity.UserVisit;
025import com.echothree.model.data.workflow.server.entity.WorkflowDestination;
026import com.echothree.util.common.form.TransferProperties;
027import javax.enterprise.context.RequestScoped;
028
029@RequestScoped
030public class WorkflowDestinationTransferCache
031        extends BaseWorkflowTransferCache<WorkflowDestination, WorkflowDestinationTransfer> {
032
033    @Inject
034    WorkflowControl workflowControl;
035
036    TransferProperties transferProperties;
037    boolean filterWorkflowStep;
038    boolean filterWorkflowDestinationName;
039    boolean filterIsDefault;
040    boolean filterSortOrder;
041    boolean filterDescription;
042    boolean filterEntityInstance;
043    
044    /** Creates a new instance of WorkflowDestinationTransferCache */
045    protected WorkflowDestinationTransferCache() {
046        super();
047        
048        transferProperties = session.getTransferProperties();
049        if(transferProperties != null) {
050            var properties = transferProperties.getProperties(WorkflowEntranceTransfer.class);
051            
052            if(properties != null) {
053                filterWorkflowStep = !properties.contains(WorkflowProperties.WORKFLOW_STEP);
054                filterWorkflowDestinationName = !properties.contains(WorkflowProperties.WORKFLOW_DESTINATION_NAME);
055                filterIsDefault = !properties.contains(WorkflowProperties.IS_DEFAULT);
056                filterSortOrder = !properties.contains(WorkflowProperties.SORT_ORDER);
057                filterDescription = !properties.contains(WorkflowProperties.DESCRIPTION);
058                filterEntityInstance = !properties.contains(WorkflowProperties.ENTITY_INSTANCE);
059            }
060        }
061        
062        setIncludeEntityInstance(!filterEntityInstance);
063    }
064    
065    public WorkflowDestinationTransfer getWorkflowDestinationTransfer(UserVisit userVisit, WorkflowDestination workflowDestination) {
066        var workflowDestinationTransfer = get(workflowDestination);
067        
068        if(workflowDestinationTransfer == null) {
069            var workflowDestinationDetail = workflowDestination.getLastDetail();
070            var workflowStep = filterWorkflowStep ? null : workflowControl.getWorkflowStepTransfer(userVisit, workflowDestinationDetail.getWorkflowStep());
071            var workflowDestinationName = filterWorkflowDestinationName ? null : workflowDestinationDetail.getWorkflowDestinationName();
072            var isDefault = filterIsDefault ? null : workflowDestinationDetail.getIsDefault();
073            var sortOrder = filterSortOrder ? null : workflowDestinationDetail.getSortOrder();
074            var description = filterDescription ? null : workflowControl.getBestWorkflowDestinationDescription(workflowDestination, getLanguage(userVisit));
075            
076            workflowDestinationTransfer = new WorkflowDestinationTransfer(workflowStep, workflowDestinationName, isDefault,
077                    sortOrder, description);
078            put(userVisit, workflowDestination, workflowDestinationTransfer);
079        }
080        
081        return workflowDestinationTransfer;
082    }
083    
084}