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.DeleteLetterDescriptionForm;
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 DeleteLetterDescriptionCommand
046        extends BaseSimpleCommand<DeleteLetterDescriptionForm> {
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                ));
065    }
066    
067    /** Creates a new instance of DeleteLetterDescriptionCommand */
068    public DeleteLetterDescriptionCommand(UserVisitPK userVisitPK, DeleteLetterDescriptionForm form) {
069        super(userVisitPK, form, COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
070    }
071    
072    @Override
073    protected BaseResult execute() {
074        var chainControl = Session.getModelController(ChainControl.class);
075        String chainKindName = form.getChainKindName();
076        ChainKind chainKind = chainControl.getChainKindByName(chainKindName);
077        
078        if(chainKind != null) {
079            String chainTypeName = form.getChainTypeName();
080            ChainType chainType = chainControl.getChainTypeByName(chainKind, chainTypeName);
081            
082            if(chainType != null) {
083                var letterControl = Session.getModelController(LetterControl.class);
084                String letterName = form.getLetterName();
085                Letter letter = letterControl.getLetterByName(chainType, letterName);
086                
087                if(letter != null) {
088                    var partyControl = Session.getModelController(PartyControl.class);
089                    String languageIsoName = form.getLanguageIsoName();
090                    Language language = partyControl.getLanguageByIsoName(languageIsoName);
091                    
092                    if(language != null) {
093                        LetterDescription letterDescription = letterControl.getLetterDescriptionForUpdate(letter, language);
094                        
095                        if(letterDescription != null) {
096                            letterControl.deleteLetterDescription(letterDescription, getPartyPK());
097                        } else {
098                            addExecutionError(ExecutionErrors.UnknownLetterDescription.name());
099                        }
100                    } else {
101                        addExecutionError(ExecutionErrors.UnknownLanguageIsoName.name(), languageIsoName);
102                    }
103                } else {
104                    addExecutionError(ExecutionErrors.UnknownLetterName.name(), letterName);
105                }
106            } else {
107                addExecutionError(ExecutionErrors.UnknownChainTypeName.name(), chainTypeName);
108            }
109        } else {
110            addExecutionError(ExecutionErrors.UnknownChainKindName.name(), chainKindName);
111        }
112        
113        return null;
114    }
115    
116}