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.CreateSubscriptionKindForm;
020import com.echothree.control.user.subscription.common.result.SubscriptionResultFactory;
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.control.subscription.server.control.SubscriptionControl;
025import com.echothree.model.data.subscription.server.entity.SubscriptionKind;
026import com.echothree.util.common.command.BaseResult;
027import com.echothree.util.common.message.ExecutionErrors;
028import com.echothree.util.common.validation.FieldDefinition;
029import com.echothree.util.common.validation.FieldType;
030import com.echothree.util.server.control.BaseSimpleCommand;
031import com.echothree.util.server.control.CommandSecurityDefinition;
032import com.echothree.util.server.control.PartyTypeDefinition;
033import com.echothree.util.server.control.SecurityRoleDefinition;
034import java.util.List;
035import javax.enterprise.context.Dependent;
036import javax.inject.Inject;
037
038@Dependent
039public class CreateSubscriptionKindCommand
040        extends BaseSimpleCommand<CreateSubscriptionKindForm> {
041    
042    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
043    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
044    
045    static {
046        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(List.of(
047                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
048                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
049                        new SecurityRoleDefinition(SecurityRoleGroups.SubscriptionKind.name(), SecurityRoles.Create.name())
050                ))
051        ));
052
053        FORM_FIELD_DEFINITIONS = List.of(
054                new FieldDefinition("SubscriptionKindName", FieldType.ENTITY_NAME, true, null, null),
055                new FieldDefinition("IsDefault", FieldType.BOOLEAN, true, null, null),
056                new FieldDefinition("SortOrder", FieldType.SIGNED_INTEGER, true, null, null),
057                new FieldDefinition("Description", FieldType.STRING, false, 1L, 132L)
058        );
059    }
060
061    @Inject
062    SubscriptionControl subscriptionControl;
063
064    
065    /** Creates a new instance of CreateSubscriptionKindCommand */
066    public CreateSubscriptionKindCommand() {
067        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
068    }
069    
070    @Override
071    protected BaseResult execute() {
072        var result = SubscriptionResultFactory.getCreateSubscriptionKindResult();
073        var subscriptionKindName = form.getSubscriptionKindName();
074        var subscriptionKind = subscriptionControl.getSubscriptionKindByName(subscriptionKindName);
075        
076        if(subscriptionKind == null) {
077            var partyPK = getPartyPK();
078            var isDefault = Boolean.valueOf(form.getIsDefault());
079            var sortOrder = Integer.valueOf(form.getSortOrder());
080            var description = form.getDescription();
081
082            subscriptionKind = subscriptionControl.createSubscriptionKind(subscriptionKindName, isDefault, sortOrder, partyPK);
083
084            if(description != null) {
085                subscriptionControl.createSubscriptionKindDescription(subscriptionKind, getPreferredLanguage(), description, partyPK);
086            }
087        } else {
088            addExecutionError(ExecutionErrors.DuplicateSubscriptionKindName.name(), subscriptionKindName);
089        }
090        
091        if(subscriptionKind != null) {
092            result.setEntityRef(subscriptionKind.getPrimaryKey().getEntityRef());
093            result.setSubscriptionKindName(subscriptionKind.getLastDetail().getSubscriptionKindName());
094        }
095
096        return result;
097    }
098    
099}