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.GetCommandMessageForm;
020import com.echothree.control.user.core.common.result.CoreResultFactory;
021import com.echothree.model.control.core.common.EventTypes;
022import com.echothree.model.control.party.common.PartyTypes;
023import com.echothree.model.control.security.common.SecurityRoleGroups;
024import com.echothree.model.control.security.common.SecurityRoles;
025import com.echothree.model.data.core.server.entity.CommandMessage;
026import com.echothree.util.common.command.BaseResult;
027import com.echothree.util.common.message.ExecutionErrors;
028import com.echothree.util.common.validation.FieldDefinition;
029import com.echothree.util.common.validation.FieldType;
030import com.echothree.util.server.control.BaseSingleEntityCommand;
031import com.echothree.util.server.control.CommandSecurityDefinition;
032import com.echothree.util.server.control.PartyTypeDefinition;
033import com.echothree.util.server.control.SecurityRoleDefinition;
034import java.util.List;
035import javax.enterprise.context.Dependent;
036
037@Dependent
038public class GetCommandMessageCommand
039        extends BaseSingleEntityCommand<CommandMessage, GetCommandMessageForm> {
040    
041    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
042    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
043    
044    static {
045        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(List.of(
046                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
047                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
048                        new SecurityRoleDefinition(SecurityRoleGroups.CommandMessage.name(), SecurityRoles.Review.name())
049                ))
050        ));
051        
052        FORM_FIELD_DEFINITIONS = List.of(
053                new FieldDefinition("CommandMessageTypeName", FieldType.ENTITY_NAME, true, null, null),
054                new FieldDefinition("CommandMessageKey", FieldType.KEY, true, null, null)
055        );
056    }
057    
058    /** Creates a new instance of GetCommandMessageCommand */
059    public GetCommandMessageCommand() {
060        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
061    }
062    
063    @Override
064    protected CommandMessage getEntity() {
065        var commandMessageTypeName = form.getCommandMessageTypeName();
066        var commandMessageType = commandControl.getCommandMessageTypeByName(commandMessageTypeName);
067        CommandMessage commandMessage = null;
068        
069        if(commandMessageType != null) {
070            var commandMessageKey = form.getCommandMessageKey();
071            commandMessage = commandControl.getCommandMessageByKey(commandMessageType, commandMessageKey);
072
073            if(commandMessage == null) {
074                addExecutionError(ExecutionErrors.UnknownCommandMessageKey.name(), commandMessageTypeName, commandMessageKey);
075            } else {
076                sendEvent(commandMessage.getPrimaryKey(), EventTypes.READ, null, null, getPartyPK());
077            }
078        } else {
079            addExecutionError(ExecutionErrors.UnknownCommandMessageTypeName.name(), commandMessageTypeName);
080        }
081
082        return commandMessage;
083    }
084
085    @Override
086    protected BaseResult getResult(CommandMessage commandMessage) {
087        var result = CoreResultFactory.getGetCommandMessageResult();
088
089        if(commandMessage != null) {
090            result.setCommandMessage(commandControl.getCommandMessageTransfer(getUserVisit(), commandMessage));
091        }
092
093        return result;
094    }
095    
096}