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.GetCommandMessagesForm;
020import com.echothree.control.user.core.common.result.CoreResultFactory;
021import com.echothree.model.control.core.server.control.CommandControl;
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.model.data.core.server.entity.CommandMessageType;
027import com.echothree.model.data.core.server.factory.CommandMessageFactory;
028import com.echothree.util.common.command.BaseResult;
029import com.echothree.util.common.message.ExecutionErrors;
030import com.echothree.util.common.validation.FieldDefinition;
031import com.echothree.util.common.validation.FieldType;
032import com.echothree.util.server.control.BasePaginatedMultipleEntitiesCommand;
033import com.echothree.util.server.control.CommandSecurityDefinition;
034import com.echothree.util.server.control.PartyTypeDefinition;
035import com.echothree.util.server.control.SecurityRoleDefinition;
036import java.util.Collection;
037import java.util.List;
038import javax.enterprise.context.Dependent;
039import javax.inject.Inject;
040
041@Dependent
042public class GetCommandMessagesCommand
043        extends BasePaginatedMultipleEntitiesCommand<CommandMessage, GetCommandMessagesForm> {
044    
045    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
046    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
047    
048    static {
049        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(List.of(
050                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
051                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
052                        new SecurityRoleDefinition(SecurityRoleGroups.CommandMessage.name(), SecurityRoles.List.name())
053                ))
054        ));
055        
056        FORM_FIELD_DEFINITIONS = List.of(
057                new FieldDefinition("CommandMessageTypeName", FieldType.ENTITY_NAME, true, null, null)
058        );
059    }
060
061    /** Creates a new instance of GetCommandMessagesCommand */
062    public GetCommandMessagesCommand() {
063        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, true);
064    }
065
066    CommandMessageType commandMessageType;
067
068    @Override
069    protected void handleForm() {
070        var commandMessageTypeName = form.getCommandMessageTypeName();
071
072        commandMessageType = commandControl.getCommandMessageTypeByName(commandMessageTypeName);
073
074        if(commandMessageType == null) {
075            addExecutionError(ExecutionErrors.UnknownCommandMessageTypeName.name(), commandMessageTypeName);
076        }
077    }
078
079    @Override
080    protected Long getTotalEntities() {
081        return hasExecutionErrors() ? null : commandControl.countCommandMessagesByCommandMessageType(commandMessageType);
082    }
083
084    @Override
085    protected Collection<CommandMessage> getEntities() {
086        return hasExecutionErrors() ? null : commandControl.getCommandMessagesByCommandMessageType(commandMessageType);
087    }
088
089    @Override
090    protected BaseResult getResult(Collection<CommandMessage> entities) {
091        var result = CoreResultFactory.getGetCommandMessagesResult();
092
093        if(entities != null) {
094            result.setCommandMessageType(commandControl.getCommandMessageTypeTransfer(getUserVisit(), commandMessageType));
095
096            if(session.hasLimit(CommandMessageFactory.class)) {
097                result.setCommandMessageCount(getTotalEntities());
098            }
099
100            result.setCommandMessages(commandControl.getCommandMessageTransfers(getUserVisit(), entities));
101        }
102
103        return result;
104    }
105    
106}