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.workflow.server.command;
018
019import com.echothree.control.user.workflow.common.form.DeleteWorkflowEntranceForm;
020import com.echothree.model.control.party.common.PartyTypes;
021import com.echothree.model.control.security.common.SecurityRoleGroups;
022import com.echothree.model.control.security.common.SecurityRoles;
023import com.echothree.model.control.workflow.server.control.WorkflowControl;
024import com.echothree.model.control.workflow.server.logic.WorkflowEntranceLogic;
025import com.echothree.model.data.user.common.pk.UserVisitPK;
026import com.echothree.util.common.command.BaseResult;
027import com.echothree.util.common.validation.FieldDefinition;
028import com.echothree.util.common.validation.FieldType;
029import com.echothree.util.server.control.BaseSimpleCommand;
030import com.echothree.util.server.control.CommandSecurityDefinition;
031import com.echothree.util.server.control.PartyTypeDefinition;
032import com.echothree.util.server.control.SecurityRoleDefinition;
033import com.echothree.util.server.persistence.Session;
034import java.util.List;
035
036public class DeleteWorkflowEntranceCommand
037        extends BaseSimpleCommand<DeleteWorkflowEntranceForm> {
038    
039    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
040    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
041    
042    static {
043        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(List.of(
044                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
045                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
046                        new SecurityRoleDefinition(SecurityRoleGroups.WorkflowEntrance.name(), SecurityRoles.Delete.name())
047                ))
048        ));
049
050        FORM_FIELD_DEFINITIONS = List.of(
051                new FieldDefinition("WorkflowName", FieldType.ENTITY_NAME, false, null, null),
052                new FieldDefinition("WorkflowEntranceName", FieldType.ENTITY_NAME, false, null, null),
053                new FieldDefinition("EntityRef", FieldType.ENTITY_REF, false, null, null),
054                new FieldDefinition("Key", FieldType.KEY, false, null, null),
055                new FieldDefinition("Guid", FieldType.GUID, false, null, null),
056                new FieldDefinition("Ulid", FieldType.ULID, false, null, null)
057        );
058    }
059    
060    /** Creates a new instance of DeleteWorkflowEntranceCommand */
061    public DeleteWorkflowEntranceCommand(UserVisitPK userVisitPK, DeleteWorkflowEntranceForm form) {
062        super(userVisitPK, form, COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
063    }
064    
065    @Override
066    protected BaseResult execute() {
067        var workflowEntrance = WorkflowEntranceLogic.getInstance().getWorkflowEntranceByUniversalSpecForUpdate(this, form, false);
068
069        if(!hasExecutionErrors()) {
070            var workflowControl = Session.getModelController(WorkflowControl.class);
071
072            workflowControl.deleteWorkflowEntrance(workflowEntrance, getPartyPK());
073        }
074
075        return null;
076    }
077    
078}