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