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.form.CreateProtocolForm;
020import com.echothree.model.control.party.common.PartyTypes;
021import com.echothree.model.control.security.common.SecurityRoleGroups;
022import com.echothree.model.control.security.common.SecurityRoles;
023import com.echothree.model.data.core.server.entity.Protocol;
024import com.echothree.model.data.user.common.pk.UserVisitPK;
025import com.echothree.util.common.message.ExecutionErrors;
026import com.echothree.util.common.validation.FieldDefinition;
027import com.echothree.util.common.validation.FieldType;
028import com.echothree.util.common.command.BaseResult;
029import com.echothree.util.server.control.BaseSimpleCommand;
030import com.echothree.util.server.control.CommandSecurityDefinition;
031import com.echothree.util.server.control.PartyTypeDefinition;
032import com.echothree.util.server.control.SecurityRoleDefinition;
033import java.util.Arrays;
034import java.util.Collections;
035import java.util.List;
036
037public class CreateProtocolCommand
038        extends BaseSimpleCommand<CreateProtocolForm> {
039    
040    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
041    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
042    
043    static {
044        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(Collections.unmodifiableList(Arrays.asList(
045                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
046                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), Collections.unmodifiableList(Arrays.asList(
047                        new SecurityRoleDefinition(SecurityRoleGroups.Protocol.name(), SecurityRoles.Create.name())
048                        )))
049                )));
050        
051        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
052                new FieldDefinition("ProtocolName", FieldType.ENTITY_NAME, true, null, null),
053                new FieldDefinition("IsDefault", FieldType.BOOLEAN, true, null, null),
054                new FieldDefinition("SortOrder", FieldType.SIGNED_INTEGER, true, null, null),
055                new FieldDefinition("Description", FieldType.STRING, false, 1L, 132L)
056                ));
057    }
058    
059    /** Creates a new instance of CreateProtocolCommand */
060    public CreateProtocolCommand(UserVisitPK userVisitPK, CreateProtocolForm form) {
061        super(userVisitPK, form, COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
062    }
063    
064    @Override
065    protected BaseResult execute() {
066        var coreControl = getCoreControl();
067        String protocolName = form.getProtocolName();
068        Protocol protocol = coreControl.getProtocolByName(protocolName);
069        
070        if(protocol == null) {
071            var partyPK = getPartyPK();
072            var isDefault = Boolean.valueOf(form.getIsDefault());
073            var sortOrder = Integer.valueOf(form.getSortOrder());
074            var description = form.getDescription();
075            
076            protocol = coreControl.createProtocol(protocolName, isDefault, sortOrder, partyPK);
077            
078            if(description != null) {
079                coreControl.createProtocolDescription(protocol, getPreferredLanguage(), description, partyPK);
080            }
081        } else {
082            addExecutionError(ExecutionErrors.DuplicateProtocolName.name(), protocolName);
083        }
084        
085        return null;
086    }
087    
088}