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.selector.server.command;
018
019import com.echothree.control.user.selector.common.form.CreateSelectorDescriptionForm;
020import com.echothree.model.control.party.common.PartyTypes;
021import com.echothree.model.control.party.server.control.PartyControl;
022import com.echothree.model.control.security.common.SecurityRoleGroups;
023import com.echothree.model.control.security.common.SecurityRoles;
024import com.echothree.model.control.selector.server.control.SelectorControl;
025import com.echothree.model.data.party.server.entity.Language;
026import com.echothree.model.data.selector.server.entity.Selector;
027import com.echothree.model.data.selector.server.entity.SelectorDescription;
028import com.echothree.model.data.selector.server.entity.SelectorKind;
029import com.echothree.model.data.selector.server.entity.SelectorType;
030import com.echothree.model.data.user.common.pk.UserVisitPK;
031import com.echothree.util.common.command.BaseResult;
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.BaseSimpleCommand;
036import com.echothree.util.server.control.CommandSecurityDefinition;
037import com.echothree.util.server.control.PartyTypeDefinition;
038import com.echothree.util.server.control.SecurityRoleDefinition;
039import com.echothree.util.server.persistence.Session;
040import java.util.List;
041
042public class CreateSelectorDescriptionCommand
043        extends BaseSimpleCommand<CreateSelectorDescriptionForm> {
044
045    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
046    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
047    
048    static {
049        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(List.of(
050                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
051                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
052                        new SecurityRoleDefinition(SecurityRoleGroups.Selector.name(), SecurityRoles.Description.name())
053                ))
054        ));
055
056        FORM_FIELD_DEFINITIONS = List.of(
057                new FieldDefinition("SelectorKindName", FieldType.ENTITY_NAME, true, null, null),
058                new FieldDefinition("SelectorTypeName", FieldType.ENTITY_NAME, true, null, null),
059                new FieldDefinition("SelectorName", FieldType.ENTITY_NAME, true, null, null),
060                new FieldDefinition("LanguageIsoName", FieldType.ENTITY_NAME, true, null, null),
061                new FieldDefinition("Description", FieldType.STRING, true, 1L, 132L)
062        );
063    }
064    
065    /** Creates a new instance of CreateSelectorDescriptionCommand */
066    public CreateSelectorDescriptionCommand(UserVisitPK userVisitPK, CreateSelectorDescriptionForm form) {
067        super(userVisitPK, form, COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
068    }
069    
070    @Override
071    protected BaseResult execute() {
072        var selectorControl = Session.getModelController(SelectorControl.class);
073        String selectorKindName = form.getSelectorKindName();
074        SelectorKind selectorKind = selectorControl.getSelectorKindByName(selectorKindName);
075        
076        if(selectorKind != null) {
077            String selectorTypeName = form.getSelectorTypeName();
078            SelectorType selectorType = selectorControl.getSelectorTypeByName(selectorKind, selectorTypeName);
079            
080            if(selectorType != null) {
081                String selectorName = form.getSelectorName();
082                Selector selector = selectorControl.getSelectorByName(selectorType, selectorName);
083                
084                if(selector != null) {
085                    var partyControl = Session.getModelController(PartyControl.class);
086                    String languageIsoName = form.getLanguageIsoName();
087                    Language language = partyControl.getLanguageByIsoName(languageIsoName);
088                    
089                    if(language != null) {
090                        SelectorDescription selectorDescription = selectorControl.getSelectorDescription(selector, language);
091                        
092                        if(selectorDescription == null) {
093                            var description = form.getDescription();
094                            
095                            selectorControl.createSelectorDescription(selector, language, description, getPartyPK());
096                        } else {
097                            addExecutionError(ExecutionErrors.DuplicateSelectorDescription.name());
098                        }
099                    } else {
100                        addExecutionError(ExecutionErrors.UnknownLanguageIsoName.name(), languageIsoName);
101                    }
102                } else {
103                    addExecutionError(ExecutionErrors.UnknownSelectorName.name(), selectorName);
104                }
105            } else {
106                addExecutionError(ExecutionErrors.UnknownSelectorTypeName.name(), selectorTypeName);
107            }
108        } else {
109            addExecutionError(ExecutionErrors.UnknownSelectorKindName.name(), selectorKindName);
110        }
111        
112        return null;
113    }
114    
115}