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.ProtocolEdit;
021import com.echothree.control.user.core.common.form.EditProtocolForm;
022import com.echothree.control.user.core.common.result.CoreResultFactory;
023import com.echothree.control.user.core.common.result.EditProtocolResult;
024import com.echothree.control.user.core.common.spec.ProtocolSpec;
025import com.echothree.model.control.core.server.control.ServerControl;
026import com.echothree.model.control.party.common.PartyTypes;
027import com.echothree.model.control.security.common.SecurityRoleGroups;
028import com.echothree.model.control.security.common.SecurityRoles;
029import com.echothree.model.data.core.server.entity.Protocol;
030import com.echothree.model.data.user.common.pk.UserVisitPK;
031import com.echothree.util.common.command.EditMode;
032import com.echothree.util.common.message.ExecutionErrors;
033import com.echothree.util.common.validation.FieldDefinition;
034import com.echothree.util.common.validation.FieldType;
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 EditProtocolCommand
045        extends BaseAbstractEditCommand<ProtocolSpec, ProtocolEdit, EditProtocolResult, Protocol, Protocol> {
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.Protocol.name(), SecurityRoles.Edit.name())
056                ))
057        ));
058        
059        SPEC_FIELD_DEFINITIONS = List.of(
060                new FieldDefinition("ProtocolName", FieldType.ENTITY_NAME, true, null, null)
061        );
062        
063        EDIT_FIELD_DEFINITIONS = List.of(
064                new FieldDefinition("ProtocolName", FieldType.ENTITY_NAME, true, null, null),
065                new FieldDefinition("IsDefault", FieldType.BOOLEAN, true, null, null),
066                new FieldDefinition("SortOrder", FieldType.SIGNED_INTEGER, true, null, null),
067                new FieldDefinition("Description", FieldType.STRING, false, 1L, 132L)
068        );
069    }
070
071    @Inject
072    ServerControl serverControl;
073
074    
075    /** Creates a new instance of EditProtocolCommand */
076    public EditProtocolCommand() {
077        super(COMMAND_SECURITY_DEFINITION, SPEC_FIELD_DEFINITIONS, EDIT_FIELD_DEFINITIONS);
078    }
079    
080    @Override
081    public EditProtocolResult getResult() {
082        return CoreResultFactory.getEditProtocolResult();
083    }
084
085    @Override
086    public ProtocolEdit getEdit() {
087        return CoreEditFactory.getProtocolEdit();
088    }
089
090    @Override
091    public Protocol getEntity(EditProtocolResult result) {
092        Protocol protocol;
093        var protocolName = spec.getProtocolName();
094
095        if(editMode.equals(EditMode.LOCK) || editMode.equals(EditMode.ABANDON)) {
096            protocol = serverControl.getProtocolByName(protocolName);
097        } else { // EditMode.UPDATE
098            protocol = serverControl.getProtocolByNameForUpdate(protocolName);
099        }
100
101        if(protocol != null) {
102            result.setProtocol(serverControl.getProtocolTransfer(getUserVisit(), protocol));
103        } else {
104            addExecutionError(ExecutionErrors.UnknownProtocolName.name(), protocolName);
105        }
106
107        return protocol;
108    }
109
110    @Override
111    public Protocol getLockEntity(Protocol protocol) {
112        return protocol;
113    }
114
115    @Override
116    public void fillInResult(EditProtocolResult result, Protocol protocol) {
117        result.setProtocol(serverControl.getProtocolTransfer(getUserVisit(), protocol));
118    }
119
120    @Override
121    public void doLock(ProtocolEdit edit, Protocol protocol) {
122        var protocolDescription = serverControl.getProtocolDescription(protocol, getPreferredLanguage());
123        var protocolDetail = protocol.getLastDetail();
124
125        edit.setProtocolName(protocolDetail.getProtocolName());
126        edit.setIsDefault(protocolDetail.getIsDefault().toString());
127        edit.setSortOrder(protocolDetail.getSortOrder().toString());
128
129        if(protocolDescription != null) {
130            edit.setDescription(protocolDescription.getDescription());
131        }
132    }
133
134    @Override
135    public void canUpdate(Protocol protocol) {
136        var protocolName = edit.getProtocolName();
137        var duplicateProtocol = serverControl.getProtocolByName(protocolName);
138
139        if(duplicateProtocol != null && !protocol.equals(duplicateProtocol)) {
140            addExecutionError(ExecutionErrors.DuplicateProtocolName.name(), protocolName);
141        }
142    }
143
144    @Override
145    public void doUpdate(Protocol protocol) {
146        var partyPK = getPartyPK();
147        var protocolDetailValue = serverControl.getProtocolDetailValueForUpdate(protocol);
148        var protocolDescription = serverControl.getProtocolDescriptionForUpdate(protocol, getPreferredLanguage());
149        var description = edit.getDescription();
150
151        protocolDetailValue.setProtocolName(edit.getProtocolName());
152        protocolDetailValue.setIsDefault(Boolean.valueOf(edit.getIsDefault()));
153        protocolDetailValue.setSortOrder(Integer.valueOf(edit.getSortOrder()));
154
155        serverControl.updateProtocolFromValue(protocolDetailValue, partyPK);
156
157        if(protocolDescription == null && description != null) {
158            serverControl.createProtocolDescription(protocol, getPreferredLanguage(), description, partyPK);
159        } else {
160            if(protocolDescription != null && description == null) {
161                serverControl.deleteProtocolDescription(protocolDescription, partyPK);
162            } else {
163                if(protocolDescription != null && description != null) {
164                    var protocolDescriptionValue = serverControl.getProtocolDescriptionValue(protocolDescription);
165
166                    protocolDescriptionValue.setDescription(description);
167                    serverControl.updateProtocolDescriptionFromValue(protocolDescriptionValue, partyPK);
168                }
169            }
170        }
171    }
172    
173}