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.letter.server.command;
018
019import com.echothree.control.user.letter.common.form.CreateLetterDescriptionForm;
020import com.echothree.model.control.chain.server.control.ChainControl;
021import com.echothree.model.control.letter.server.control.LetterControl;
022import com.echothree.model.control.party.common.PartyTypes;
023import com.echothree.model.control.party.server.control.PartyControl;
024import com.echothree.model.control.security.common.SecurityRoleGroups;
025import com.echothree.model.control.security.common.SecurityRoles;
026import com.echothree.model.data.chain.server.entity.ChainKind;
027import com.echothree.model.data.chain.server.entity.ChainType;
028import com.echothree.model.data.letter.server.entity.Letter;
029import com.echothree.model.data.letter.server.entity.LetterDescription;
030import com.echothree.model.data.party.server.entity.Language;
031import com.echothree.model.data.user.common.pk.UserVisitPK;
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.common.command.BaseResult;
036import com.echothree.util.server.control.BaseSimpleCommand;
037import com.echothree.util.server.control.CommandSecurityDefinition;
038import com.echothree.util.server.control.PartyTypeDefinition;
039import com.echothree.util.server.control.SecurityRoleDefinition;
040import com.echothree.util.server.persistence.Session;
041import java.util.Arrays;
042import java.util.Collections;
043import java.util.List;
044
045public class CreateLetterDescriptionCommand
046        extends BaseSimpleCommand<CreateLetterDescriptionForm> {
047    
048    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
049    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
050    
051    static {
052        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(Collections.unmodifiableList(Arrays.asList(
053                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
054                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), Collections.unmodifiableList(Arrays.asList(
055                    new SecurityRoleDefinition(SecurityRoleGroups.Letter.name(), SecurityRoles.Description.name())
056                    )))
057                )));
058        
059        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
060                new FieldDefinition("ChainKindName", FieldType.ENTITY_NAME, true, null, null),
061                new FieldDefinition("ChainTypeName", FieldType.ENTITY_NAME, true, null, null),
062                new FieldDefinition("LetterName", FieldType.ENTITY_NAME, true, null, null),
063                new FieldDefinition("LanguageIsoName", FieldType.ENTITY_NAME, true, null, null),
064                new FieldDefinition("Description", FieldType.STRING, true, 1L, 132L)
065                ));
066    }
067    
068    /** Creates a new instance of CreateLetterDescriptionCommand */
069    public CreateLetterDescriptionCommand(UserVisitPK userVisitPK, CreateLetterDescriptionForm form) {
070        super(userVisitPK, form, COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
071    }
072    
073    @Override
074    protected BaseResult execute() {
075        var chainControl = Session.getModelController(ChainControl.class);
076        String chainKindName = form.getChainKindName();
077        ChainKind chainKind = chainControl.getChainKindByName(chainKindName);
078        
079        if(chainKind != null) {
080            String chainTypeName = form.getChainTypeName();
081            ChainType chainType = chainControl.getChainTypeByName(chainKind, chainTypeName);
082            
083            if(chainType != null) {
084                var letterControl = Session.getModelController(LetterControl.class);
085                String letterName = form.getLetterName();
086                Letter letter = letterControl.getLetterByName(chainType, letterName);
087                
088                if(letter != null) {
089                    var partyControl = Session.getModelController(PartyControl.class);
090                    String languageIsoName = form.getLanguageIsoName();
091                    Language language = partyControl.getLanguageByIsoName(languageIsoName);
092                    
093                    if(language != null) {
094                        LetterDescription letterDescription = letterControl.getLetterDescription(letter, language);
095                        
096                        if(letterDescription == null) {
097                            var description = form.getDescription();
098                            
099                            letterControl.createLetterDescription(letter, language, description, getPartyPK());
100                        } else {
101                            addExecutionError(ExecutionErrors.DuplicateLetterDescription.name());
102                        }
103                    } else {
104                        addExecutionError(ExecutionErrors.UnknownLanguageIsoName.name(), languageIsoName);
105                    }
106                } else {
107                    addExecutionError(ExecutionErrors.UnknownLetterName.name(), letterName);
108                }
109            } else {
110                addExecutionError(ExecutionErrors.UnknownChainTypeName.name(), chainTypeName);
111            }
112        } else {
113            addExecutionError(ExecutionErrors.UnknownChainKindName.name(), chainKindName);
114        }
115        
116        return null;
117    }
118    
119}