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