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.core.server.command;
018
019import com.echothree.control.user.core.common.edit.CoreEditFactory;
020import com.echothree.control.user.core.common.edit.ProtocolDescriptionEdit;
021import com.echothree.control.user.core.common.form.EditProtocolDescriptionForm;
022import com.echothree.control.user.core.common.result.CoreResultFactory;
023import com.echothree.control.user.core.common.result.EditProtocolDescriptionResult;
024import com.echothree.control.user.core.common.spec.ProtocolDescriptionSpec;
025import com.echothree.model.control.core.server.control.ServerControl;
026import com.echothree.model.control.party.common.PartyTypes;
027import com.echothree.model.control.party.server.control.PartyControl;
028import com.echothree.model.control.security.common.SecurityRoleGroups;
029import com.echothree.model.control.security.common.SecurityRoles;
030import com.echothree.model.data.core.server.entity.Protocol;
031import com.echothree.model.data.core.server.entity.ProtocolDescription;
032import com.echothree.model.data.user.common.pk.UserVisitPK;
033import com.echothree.util.common.command.EditMode;
034import com.echothree.util.common.message.ExecutionErrors;
035import com.echothree.util.common.validation.FieldDefinition;
036import com.echothree.util.common.validation.FieldType;
037import com.echothree.util.server.control.BaseAbstractEditCommand;
038import com.echothree.util.server.control.CommandSecurityDefinition;
039import com.echothree.util.server.control.PartyTypeDefinition;
040import com.echothree.util.server.control.SecurityRoleDefinition;
041import java.util.List;
042import javax.enterprise.context.Dependent;
043import javax.inject.Inject;
044
045@Dependent
046public class EditProtocolDescriptionCommand
047        extends BaseAbstractEditCommand<ProtocolDescriptionSpec, ProtocolDescriptionEdit, EditProtocolDescriptionResult, ProtocolDescription, Protocol> {
048    
049    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
050    private final static List<FieldDefinition> SPEC_FIELD_DEFINITIONS;
051    private final static List<FieldDefinition> EDIT_FIELD_DEFINITIONS;
052    
053    static {
054        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(List.of(
055                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
056                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
057                        new SecurityRoleDefinition(SecurityRoleGroups.Protocol.name(), SecurityRoles.Description.name())
058                ))
059        ));
060        
061        SPEC_FIELD_DEFINITIONS = List.of(
062                new FieldDefinition("ProtocolName", FieldType.ENTITY_NAME, true, null, null),
063                new FieldDefinition("LanguageIsoName", FieldType.ENTITY_NAME, true, null, null)
064        );
065        
066        EDIT_FIELD_DEFINITIONS = List.of(
067                new FieldDefinition("Description", FieldType.STRING, true, 1L, 132L)
068        );
069    }
070
071    @Inject
072    PartyControl partyControl;
073
074    @Inject
075    ServerControl serverControl;
076
077    
078    /** Creates a new instance of EditProtocolDescriptionCommand */
079    public EditProtocolDescriptionCommand() {
080        super(COMMAND_SECURITY_DEFINITION, SPEC_FIELD_DEFINITIONS, EDIT_FIELD_DEFINITIONS);
081    }
082    
083    @Override
084    public EditProtocolDescriptionResult getResult() {
085        return CoreResultFactory.getEditProtocolDescriptionResult();
086    }
087
088    @Override
089    public ProtocolDescriptionEdit getEdit() {
090        return CoreEditFactory.getProtocolDescriptionEdit();
091    }
092
093    @Override
094    public ProtocolDescription getEntity(EditProtocolDescriptionResult result) {
095        ProtocolDescription protocolDescription = null;
096        var protocolName = spec.getProtocolName();
097        var protocol = serverControl.getProtocolByName(protocolName);
098
099        if(protocol != null) {
100            var languageIsoName = spec.getLanguageIsoName();
101            var language = partyControl.getLanguageByIsoName(languageIsoName);
102
103            if(language != null) {
104                if(editMode.equals(EditMode.LOCK) || editMode.equals(EditMode.ABANDON)) {
105                    protocolDescription = serverControl.getProtocolDescription(protocol, language);
106                } else { // EditMode.UPDATE
107                    protocolDescription = serverControl.getProtocolDescriptionForUpdate(protocol, language);
108                }
109
110                if(protocolDescription == null) {
111                    addExecutionError(ExecutionErrors.UnknownProtocolDescription.name(), protocolName, languageIsoName);
112                }
113            } else {
114                addExecutionError(ExecutionErrors.UnknownLanguageIsoName.name(), languageIsoName);
115            }
116        } else {
117            addExecutionError(ExecutionErrors.UnknownProtocolName.name(), protocolName);
118        }
119
120        return protocolDescription;
121    }
122
123    @Override
124    public Protocol getLockEntity(ProtocolDescription protocolDescription) {
125        return protocolDescription.getProtocol();
126    }
127
128    @Override
129    public void fillInResult(EditProtocolDescriptionResult result, ProtocolDescription protocolDescription) {
130        result.setProtocolDescription(serverControl.getProtocolDescriptionTransfer(getUserVisit(), protocolDescription));
131    }
132
133    @Override
134    public void doLock(ProtocolDescriptionEdit edit, ProtocolDescription protocolDescription) {
135        edit.setDescription(protocolDescription.getDescription());
136    }
137
138    @Override
139    public void doUpdate(ProtocolDescription protocolDescription) {
140        var protocolDescriptionValue = serverControl.getProtocolDescriptionValue(protocolDescription);
141        protocolDescriptionValue.setDescription(edit.getDescription());
142
143        serverControl.updateProtocolDescriptionFromValue(protocolDescriptionValue, getPartyPK());
144    }
145    
146}