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.CreateSubscriptionForm;
020import com.echothree.model.control.party.common.PartyTypes;
021import com.echothree.model.control.party.server.control.PartyControl;
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.control.subscription.server.logic.SubscriptionLogic;
026import com.echothree.model.control.uom.common.UomConstants;
027import com.echothree.model.control.uom.server.control.UomControl;
028import com.echothree.model.control.uom.server.util.Conversion;
029import com.echothree.model.data.uom.server.entity.UnitOfMeasureType;
030import com.echothree.util.common.command.BaseResult;
031import com.echothree.util.common.message.ExecutionErrors;
032import com.echothree.util.common.validation.FieldDefinition;
033import com.echothree.util.common.validation.FieldType;
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 java.util.List;
039import javax.enterprise.context.Dependent;
040import javax.inject.Inject;
041
042@Dependent
043public class CreateSubscriptionCommand
044        extends BaseSimpleCommand<CreateSubscriptionForm> {
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(List.of(
051                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
052                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
053                        new SecurityRoleDefinition(SecurityRoleGroups.Subscription.name(), SecurityRoles.Create.name())
054                ))
055        ));
056
057        FORM_FIELD_DEFINITIONS = List.of(
058                new FieldDefinition("SubscriptionKindName", FieldType.ENTITY_NAME, true, null, null),
059                new FieldDefinition("SubscriptionTypeName", FieldType.ENTITY_NAME, true, null, null),
060                new FieldDefinition("PartyName", FieldType.ENTITY_NAME, true, null, null),
061                new FieldDefinition("UnitOfMeasureTypeName", FieldType.ENTITY_NAME, false, null, null),
062                new FieldDefinition("SubscriptionTime", FieldType.UNSIGNED_LONG, false, null, null)
063        );
064    }
065
066    @Inject
067    PartyControl partyControl;
068
069    @Inject
070    SubscriptionControl subscriptionControl;
071
072    @Inject
073    UomControl uomControl;
074
075    @Inject
076    SubscriptionLogic subscriptionLogic;
077
078    
079    /** Creates a new instance of CreateSubscriptionCommand */
080    public CreateSubscriptionCommand() {
081        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
082    }
083    
084    @Override
085    protected BaseResult execute() {
086        var subscriptionKindName = form.getSubscriptionKindName();
087        var subscriptionKind = subscriptionControl.getSubscriptionKindByName(subscriptionKindName);
088        
089        if(subscriptionKind != null) {
090            var subscriptionTypeName = form.getSubscriptionTypeName();
091            var subscriptionType = subscriptionControl.getSubscriptionTypeByName(subscriptionKind, subscriptionTypeName);
092            
093            if(subscriptionType != null) {
094                var partyName = form.getPartyName();
095                var party = partyControl.getPartyByName(partyName);
096                
097                if(party != null) {
098                    var subscription = subscriptionControl.getSubscription(subscriptionType, party);
099                    
100                    if(subscription == null) {
101                        var unitOfMeasureTypeName = form.getUnitOfMeasureTypeName();
102                        UnitOfMeasureType unitOfMeasureType = null;
103                        
104                        if(unitOfMeasureTypeName != null) {
105                            var unitOfMeasureKind = uomControl.getUnitOfMeasureKindByUnitOfMeasureKindUseTypeUsingNames(UomConstants.UnitOfMeasureKindUseType_TIME);
106                            
107                            unitOfMeasureType = uomControl.getUnitOfMeasureTypeByName(unitOfMeasureKind, unitOfMeasureTypeName);
108                        }
109                        
110                        if(unitOfMeasureTypeName == null || unitOfMeasureType != null) {
111                            var strSubscriptionTime = form.getSubscriptionTime();
112                            var subscriptionTime = strSubscriptionTime == null? null: Long.valueOf(strSubscriptionTime);
113                            
114                            if(unitOfMeasureTypeName == null || subscriptionTime != null) {
115                                Long endTime = null;
116                                var createdBy = getPartyPK();
117                                
118                                if(subscriptionTime != null) {
119                                    var conversion = new Conversion(uomControl, unitOfMeasureType, subscriptionTime).convertToLowestUnitOfMeasureType();
120                                    endTime = session.getStartTime() + conversion.getQuantity();
121                                }
122                                
123                                // ExecutionErrorAccumulator is passed in as null so that an Exception will be thrown if there is an error.
124                                subscriptionLogic.createSubscription(null, session, subscriptionType, party, endTime, createdBy);
125                            } else {
126                                addExecutionError(ExecutionErrors.MissingSubscriptionTime.name());
127                            }
128                        } else {
129                            addExecutionError(ExecutionErrors.UnknownUnitOfMeasureTypeName.name(), unitOfMeasureTypeName);
130                        }
131                    } else {
132                        addExecutionError(ExecutionErrors.DuplicateSubscription.name());
133                    }
134                } else {
135                    addExecutionError(ExecutionErrors.UnknownPartyName.name(), partyName);
136                }
137            } else {
138                addExecutionError(ExecutionErrors.UnknownSubscriptionTypeName.name(), subscriptionTypeName);
139            }
140        } else {
141            addExecutionError(ExecutionErrors.UnknownSubscriptionKindName.name(), subscriptionKindName);
142        }
143        
144        return null;
145    }
146    
147}