001// --------------------------------------------------------------------------------
002// Copyright 2002-2026 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.GetCommandForm;
020import com.echothree.control.user.core.common.result.CoreResultFactory;
021import com.echothree.model.control.core.common.EventTypes;
022import com.echothree.model.control.core.server.logic.ComponentVendorLogic;
023import com.echothree.model.data.core.server.entity.Command;
024import com.echothree.util.common.command.BaseResult;
025import com.echothree.util.common.message.ExecutionErrors;
026import com.echothree.util.common.validation.FieldDefinition;
027import com.echothree.util.common.validation.FieldType;
028import com.echothree.util.server.control.BaseSingleEntityCommand;
029import java.util.List;
030import javax.enterprise.context.Dependent;
031import javax.inject.Inject;
032
033@Dependent
034public class GetCommandCommand
035        extends BaseSingleEntityCommand<Command, GetCommandForm> {
036
037    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
038
039    static {
040        FORM_FIELD_DEFINITIONS = List.of(
041                new FieldDefinition("ComponentVendorName", FieldType.ENTITY_NAME, true, null, null),
042                new FieldDefinition("CommandName", FieldType.COMMAND_NAME, true, null, null)
043        );
044    }
045
046    @Inject
047    ComponentVendorLogic componentVendorLogic;
048
049    /** Creates a new instance of GetCommandCommand */
050    public GetCommandCommand() {
051        super(null, FORM_FIELD_DEFINITIONS, true);
052    }
053
054    @Override
055    protected Command getEntity() {
056        var componentVendorName = form.getComponentVendorName();
057        var componentVendor = componentVendorLogic.getComponentVendorByName(this, componentVendorName);
058        Command command = null;
059
060        if(!hasExecutionErrors()) {
061            var commandName = form.getCommandName();
062            command = commandControl.getCommandByName(componentVendor, commandName);
063
064            if(command == null) {
065                addExecutionError(ExecutionErrors.UnknownCommandName.name(), componentVendorName, commandName);
066            } else {
067                sendEvent(command.getPrimaryKey(), EventTypes.READ, null, null, getPartyPK());
068            }
069        }
070
071        return command;
072    }
073
074    @Override
075    protected BaseResult getResult(Command command) {
076        var result = CoreResultFactory.getGetCommandResult();
077
078        if(command != null) {
079            result.setCommand(commandControl.getCommandTransfer(getUserVisit(), command));
080        }
081
082        return result;
083    }
084
085}