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.letter.server.command;
018
019import com.echothree.control.user.letter.common.form.DeleteQueuedLetterForm;
020import com.echothree.control.user.letter.common.result.GetQueuedLetterResult;
021import com.echothree.control.user.letter.common.result.LetterResultFactory;
022import com.echothree.model.control.chain.server.control.ChainControl;
023import com.echothree.model.control.letter.server.control.LetterControl;
024import com.echothree.model.control.party.common.PartyTypes;
025import com.echothree.model.control.security.common.SecurityRoleGroups;
026import com.echothree.model.control.security.common.SecurityRoles;
027import com.echothree.model.data.chain.server.entity.ChainInstance;
028import com.echothree.model.data.letter.server.entity.QueuedLetter;
029import com.echothree.model.data.user.common.pk.UserVisitPK;
030import com.echothree.util.common.message.ExecutionErrors;
031import com.echothree.util.common.validation.FieldDefinition;
032import com.echothree.util.common.validation.FieldType;
033import com.echothree.util.common.command.BaseResult;
034import com.echothree.util.server.control.BaseSimpleCommand;
035import com.echothree.util.server.control.CommandSecurityDefinition;
036import com.echothree.util.server.control.PartyTypeDefinition;
037import com.echothree.util.server.control.SecurityRoleDefinition;
038import com.echothree.util.server.persistence.Session;
039import java.util.Arrays;
040import java.util.Collections;
041import java.util.List;
042
043public class DeleteQueuedLetterCommand
044        extends BaseSimpleCommand<DeleteQueuedLetterForm> {
045    
046    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
047    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
048    
049    static {
050        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(Collections.unmodifiableList(Arrays.asList(
051                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
052                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), Collections.unmodifiableList(Arrays.asList(
053                        new SecurityRoleDefinition(SecurityRoleGroups.QueuedLetter.name(), SecurityRoles.Delete.name())
054                        )))
055                )));
056
057        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
058                new FieldDefinition("ChainInstanceName", FieldType.ENTITY_NAME, true, null, null),
059                new FieldDefinition("QueuedLetterSequence", FieldType.UNSIGNED_INTEGER, true, null, null)
060                ));
061    }
062    
063    /** Creates a new instance of DeleteQueuedLetterCommand */
064    public DeleteQueuedLetterCommand(UserVisitPK userVisitPK, DeleteQueuedLetterForm form) {
065        super(userVisitPK, form, COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, true);
066    }
067    
068    @Override
069    protected BaseResult execute() {
070        var chainControl = Session.getModelController(ChainControl.class);
071        GetQueuedLetterResult result = LetterResultFactory.getGetQueuedLetterResult();
072        String chainInstanceName = form.getChainInstanceName();
073        ChainInstance chainInstance = chainControl.getChainInstanceByName(chainInstanceName);
074        
075        if(chainInstance != null) {
076            var letterControl = Session.getModelController(LetterControl.class);
077            Integer queuedLetterSequence = Integer.valueOf(form.getQueuedLetterSequence());
078            QueuedLetter queuedLetter = letterControl.getQueuedLetterForUpdate(chainInstance, queuedLetterSequence);
079
080            if(queuedLetter != null) {
081                letterControl.removeQueuedLetter(queuedLetter, getPartyPK());
082            } else {
083                addExecutionError(ExecutionErrors.UnknownQueuedLetter.name(), chainInstanceName, queuedLetterSequence.toString());
084            }
085        } else {
086            addExecutionError(ExecutionErrors.UnknownChainInstanceName.name(), chainInstanceName);
087        }
088        
089        return result;
090    }
091    
092}