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