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.subscription.server.command;
018
019import com.echothree.control.user.subscription.common.form.DeleteSubscriptionForm;
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.subscription.server.control.SubscriptionControl;
024import com.echothree.util.common.command.BaseResult;
025import com.echothree.util.common.message.ExecutionErrors;
026import com.echothree.util.common.validation.FieldDefinition;
027import com.echothree.util.common.validation.FieldType;
028import com.echothree.util.server.control.BaseSimpleCommand;
029import com.echothree.util.server.control.CommandSecurityDefinition;
030import com.echothree.util.server.control.PartyTypeDefinition;
031import com.echothree.util.server.control.SecurityRoleDefinition;
032import com.echothree.util.server.persistence.Session;
033import java.util.List;
034import javax.enterprise.context.Dependent;
035
036@Dependent
037public class DeleteSubscriptionCommand
038        extends BaseSimpleCommand<DeleteSubscriptionForm> {
039
040    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
041    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
042    
043    static {
044        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(List.of(
045                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
046                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
047                        new SecurityRoleDefinition(SecurityRoleGroups.Subscription.name(), SecurityRoles.Delete.name())
048                ))
049        ));
050
051        FORM_FIELD_DEFINITIONS = List.of(
052                new FieldDefinition("SubscriptionName", FieldType.ENTITY_NAME, true, null, null)
053        );
054    }
055    
056    /** Creates a new instance of DeleteSubscriptionCommand */
057    public DeleteSubscriptionCommand() {
058        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
059    }
060    
061    @Override
062    protected BaseResult execute() {
063        var subscriptionControl = Session.getModelController(SubscriptionControl.class);
064        var subscriptionName = form.getSubscriptionName();
065        var subscription = subscriptionControl.getSubscriptionByNameForUpdate(subscriptionName);
066        
067        if(subscription != null) {
068            subscriptionControl.deleteSubscription(subscription, getPartyPK());
069        } else {
070            addExecutionError(ExecutionErrors.UnknownSubscriptionName.name(), subscriptionName);
071        }
072        
073        return null;
074    }
075    
076}