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.GetCommandsForm;
020import com.echothree.control.user.core.common.result.CoreResultFactory;
021import com.echothree.control.user.core.common.result.GetCommandsResult;
022import com.echothree.model.data.core.server.entity.ComponentVendor;
023import com.echothree.model.data.user.common.pk.UserVisitPK;
024import com.echothree.util.common.message.ExecutionErrors;
025import com.echothree.util.common.validation.FieldDefinition;
026import com.echothree.util.common.validation.FieldType;
027import com.echothree.util.common.command.BaseResult;
028import com.echothree.util.server.control.BaseSimpleCommand;
029import java.util.Arrays;
030import java.util.Collections;
031import java.util.List;
032
033public class GetCommandsCommand
034        extends BaseSimpleCommand<GetCommandsForm> {
035    
036    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
037    
038    static {
039        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
040                new FieldDefinition("ComponentVendorName", FieldType.ENTITY_NAME, false, null, null)
041                ));
042    }
043    
044    /** Creates a new instance of GetCommandsCommand */
045    public GetCommandsCommand(UserVisitPK userVisitPK, GetCommandsForm form) {
046        super(userVisitPK, form, null, FORM_FIELD_DEFINITIONS, true);
047    }
048    
049    @Override
050    protected BaseResult execute() {
051        var coreControl = getCoreControl();
052        GetCommandsResult result = CoreResultFactory.getGetCommandsResult();
053        String componentVendorName = form.getComponentVendorName();
054        
055        if(componentVendorName == null) {
056            result.setCommands(coreControl.getCommandTransfers(getUserVisit()));
057        } else {
058            ComponentVendor componentVendor = coreControl.getComponentVendorByName(componentVendorName);
059            
060            if(componentVendor != null) {
061                result.setCommands(coreControl.getCommandTransfersByComponentVendor(getUserVisit(), componentVendor));
062            } else {
063                addExecutionError(ExecutionErrors.UnknownComponentVendorName.name(), componentVendorName);
064            }
065        }
066        
067        return result;
068    }
069    
070}