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.GetCommandMessageTranslationsForm;
020import com.echothree.control.user.core.common.result.CoreResultFactory;
021import com.echothree.control.user.core.common.result.GetCommandMessageTranslationsResult;
022import com.echothree.model.data.core.server.entity.CommandMessage;
023import com.echothree.model.data.core.server.entity.CommandMessageType;
024import com.echothree.model.data.user.common.pk.UserVisitPK;
025import com.echothree.model.data.user.server.entity.UserVisit;
026import com.echothree.util.common.message.ExecutionErrors;
027import com.echothree.util.common.validation.FieldDefinition;
028import com.echothree.util.common.validation.FieldType;
029import com.echothree.util.common.command.BaseResult;
030import com.echothree.util.server.control.BaseSimpleCommand;
031import java.util.Arrays;
032import java.util.Collections;
033import java.util.List;
034
035public class GetCommandMessageTranslationsCommand
036        extends BaseSimpleCommand<GetCommandMessageTranslationsForm> {
037    
038    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
039    
040    static {
041        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
042                new FieldDefinition("CommandMessageTypeName", FieldType.ENTITY_NAME, true, null, null),
043                new FieldDefinition("CommandMessageKey", FieldType.COMMAND_NAME, true, null, null)
044                ));
045    }
046    
047    /** Creates a new instance of GetCommandMessageTranslationsCommand */
048    public GetCommandMessageTranslationsCommand(UserVisitPK userVisitPK, GetCommandMessageTranslationsForm form) {
049        super(userVisitPK, form, null, FORM_FIELD_DEFINITIONS, true);
050    }
051    
052    @Override
053    protected BaseResult execute() {
054        var coreControl = getCoreControl();
055        GetCommandMessageTranslationsResult result = CoreResultFactory.getGetCommandMessageTranslationsResult();
056        String commandMessageTypeName = form.getCommandMessageTypeName();
057        CommandMessageType commandMessageType = coreControl.getCommandMessageTypeByName(commandMessageTypeName);
058        
059        if(commandMessageType != null) {
060            String commandMessageKey = form.getCommandMessageKey();
061            CommandMessage commandMessage = coreControl.getCommandMessageByKey(commandMessageType, commandMessageKey);
062            
063            if(commandMessage != null) {
064                UserVisit userVisit = getUserVisit();
065                
066                result.setCommandMessage(coreControl.getCommandMessageTransfer(userVisit, commandMessage));
067                result.setCommandMessageTranslations(coreControl.getCommandMessageTranslationTransfersByCommandMessage(userVisit, commandMessage));
068            } else {
069                addExecutionError(ExecutionErrors.UnknownCommandMessageKey.name(), commandMessageTypeName, commandMessageKey);
070            }
071        } else {
072            addExecutionError(ExecutionErrors.UnknownCommandMessageTypeName.name(), commandMessageTypeName);
073        }
074        
075        return result;
076    }
077    
078}