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.control.user.workflow.server.command;
018
019import com.echothree.control.user.workflow.common.edit.WorkflowDescriptionEdit;
020import com.echothree.control.user.workflow.common.edit.WorkflowEditFactory;
021import com.echothree.control.user.workflow.common.result.EditWorkflowDescriptionResult;
022import com.echothree.control.user.workflow.common.result.WorkflowResultFactory;
023import com.echothree.control.user.workflow.common.spec.WorkflowDescriptionSpec;
024import com.echothree.model.control.party.common.PartyTypes;
025import com.echothree.model.control.party.server.control.PartyControl;
026import com.echothree.model.control.security.common.SecurityRoleGroups;
027import com.echothree.model.control.security.common.SecurityRoles;
028import com.echothree.model.control.workflow.server.control.WorkflowControl;
029import com.echothree.model.data.workflow.server.entity.Workflow;
030import com.echothree.model.data.workflow.server.entity.WorkflowDescription;
031import com.echothree.util.common.message.ExecutionErrors;
032import com.echothree.util.common.validation.FieldDefinition;
033import com.echothree.util.common.validation.FieldType;
034import com.echothree.util.common.command.EditMode;
035import com.echothree.util.server.control.BaseAbstractEditCommand;
036import com.echothree.util.server.control.CommandSecurityDefinition;
037import com.echothree.util.server.control.PartyTypeDefinition;
038import com.echothree.util.server.control.SecurityRoleDefinition;
039import java.util.List;
040import javax.enterprise.context.Dependent;
041import javax.inject.Inject;
042
043@Dependent
044public class EditWorkflowDescriptionCommand
045        extends BaseAbstractEditCommand<WorkflowDescriptionSpec, WorkflowDescriptionEdit, EditWorkflowDescriptionResult, WorkflowDescription, Workflow> {
046    
047    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
048    private final static List<FieldDefinition> SPEC_FIELD_DEFINITIONS;
049    private final static List<FieldDefinition> EDIT_FIELD_DEFINITIONS;
050    
051    static {
052        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(List.of(
053                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
054                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
055                        new SecurityRoleDefinition(SecurityRoleGroups.Workflow.name(), SecurityRoles.Description.name())
056                ))
057        ));
058        
059        SPEC_FIELD_DEFINITIONS = List.of(
060                new FieldDefinition("WorkflowName", FieldType.ENTITY_NAME, true, null, null),
061                new FieldDefinition("LanguageIsoName", FieldType.ENTITY_NAME, true, null, null)
062        );
063        
064        EDIT_FIELD_DEFINITIONS = List.of(
065                new FieldDefinition("Description", FieldType.STRING, true, 1L, 132L)
066        );
067    }
068
069    @Inject
070    PartyControl partyControl;
071
072    @Inject
073    WorkflowControl workflowControl;
074
075    /** Creates a new instance of EditWorkflowDescriptionCommand */
076    public EditWorkflowDescriptionCommand() {
077        super(COMMAND_SECURITY_DEFINITION, SPEC_FIELD_DEFINITIONS, EDIT_FIELD_DEFINITIONS);
078    }
079
080    @Override
081    public EditWorkflowDescriptionResult getResult() {
082        return WorkflowResultFactory.getEditWorkflowDescriptionResult();
083    }
084
085    @Override
086    public WorkflowDescriptionEdit getEdit() {
087        return WorkflowEditFactory.getWorkflowDescriptionEdit();
088    }
089
090    @Override
091    public WorkflowDescription getEntity(EditWorkflowDescriptionResult result) {
092        WorkflowDescription workflowDescription = null;
093        var workflowName = spec.getWorkflowName();
094        var workflow = workflowControl.getWorkflowByName(workflowName);
095
096        if(workflow != null) {
097            var languageIsoName = spec.getLanguageIsoName();
098            var language = partyControl.getLanguageByIsoName(languageIsoName);
099
100            if(language != null) {
101                if(editMode.equals(EditMode.LOCK) || editMode.equals(EditMode.ABANDON)) {
102                    workflowDescription = workflowControl.getWorkflowDescription(workflow, language);
103                } else { // EditMode.UPDATE
104                    workflowDescription = workflowControl.getWorkflowDescriptionForUpdate(workflow, language);
105                }
106
107                if(workflowDescription == null) {
108                    addExecutionError(ExecutionErrors.UnknownWorkflowDescription.name(), workflowName, languageIsoName);
109                }
110            } else {
111                addExecutionError(ExecutionErrors.UnknownLanguageIsoName.name(), languageIsoName);
112            }
113        } else {
114            addExecutionError(ExecutionErrors.UnknownWorkflowName.name(), workflowName);
115        }
116
117        return workflowDescription;
118    }
119
120    @Override
121    public Workflow getLockEntity(WorkflowDescription workflowDescription) {
122        return workflowDescription.getWorkflow();
123    }
124
125    @Override
126    public void fillInResult(EditWorkflowDescriptionResult result, WorkflowDescription workflowDescription) {
127        result.setWorkflowDescription(workflowControl.getWorkflowDescriptionTransfer(getUserVisit(), workflowDescription));
128    }
129
130    @Override
131    public void doLock(WorkflowDescriptionEdit edit, WorkflowDescription workflowDescription) {
132        edit.setDescription(workflowDescription.getDescription());
133    }
134
135    @Override
136    public void doUpdate(WorkflowDescription workflowDescription) {
137        var workflowDescriptionValue = workflowControl.getWorkflowDescriptionValue(workflowDescription);
138
139        workflowDescriptionValue.setDescription(edit.getDescription());
140
141        workflowControl.updateWorkflowDescriptionFromValue(workflowDescriptionValue, getPartyPK());
142    }
143    
144}