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.edit.SubscriptionEditFactory;
020import com.echothree.control.user.subscription.common.edit.SubscriptionKindDescriptionEdit;
021import com.echothree.control.user.subscription.common.result.EditSubscriptionKindDescriptionResult;
022import com.echothree.control.user.subscription.common.result.SubscriptionResultFactory;
023import com.echothree.control.user.subscription.common.spec.SubscriptionKindDescriptionSpec;
024import com.echothree.model.control.party.common.PartyTypes;
025import com.echothree.model.control.party.server.control.PartyControl;
026import com.echothree.model.control.security.common.SecurityRoleGroups;
027import com.echothree.model.control.security.common.SecurityRoles;
028import com.echothree.model.control.subscription.server.control.SubscriptionControl;
029import com.echothree.model.data.subscription.server.entity.SubscriptionKind;
030import com.echothree.model.data.subscription.server.entity.SubscriptionKindDescription;
031import com.echothree.util.common.command.EditMode;
032import com.echothree.util.common.message.ExecutionErrors;
033import com.echothree.util.common.validation.FieldDefinition;
034import com.echothree.util.common.validation.FieldType;
035import com.echothree.util.server.control.BaseAbstractEditCommand;
036import com.echothree.util.server.control.CommandSecurityDefinition;
037import com.echothree.util.server.control.PartyTypeDefinition;
038import com.echothree.util.server.control.SecurityRoleDefinition;
039import java.util.List;
040import javax.enterprise.context.Dependent;
041import javax.inject.Inject;
042
043@Dependent
044public class EditSubscriptionKindDescriptionCommand
045        extends BaseAbstractEditCommand<SubscriptionKindDescriptionSpec, SubscriptionKindDescriptionEdit, EditSubscriptionKindDescriptionResult, SubscriptionKindDescription, SubscriptionKind> {
046
047    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
048    private final static List<FieldDefinition> SPEC_FIELD_DEFINITIONS;
049    private final static List<FieldDefinition> EDIT_FIELD_DEFINITIONS;
050
051    static {
052        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(List.of(
053                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
054                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
055                        new SecurityRoleDefinition(SecurityRoleGroups.SubscriptionKind.name(), SecurityRoles.Description.name())
056                ))
057        ));
058
059        SPEC_FIELD_DEFINITIONS = List.of(
060                new FieldDefinition("SubscriptionKindName", FieldType.ENTITY_NAME, true, null, null),
061                new FieldDefinition("LanguageIsoName", FieldType.ENTITY_NAME, true, null, null)
062        );
063
064        EDIT_FIELD_DEFINITIONS = List.of(
065                new FieldDefinition("Description", FieldType.STRING, true, 1L, 132L)
066        );
067    }
068
069    @Inject
070    PartyControl partyControl;
071
072    @Inject
073    SubscriptionControl subscriptionControl;
074
075    /** Creates a new instance of EditSubscriptionKindDescriptionCommand */
076    public EditSubscriptionKindDescriptionCommand() {
077        super(COMMAND_SECURITY_DEFINITION, SPEC_FIELD_DEFINITIONS, EDIT_FIELD_DEFINITIONS);
078    }
079
080    @Override
081    public EditSubscriptionKindDescriptionResult getResult() {
082        return SubscriptionResultFactory.getEditSubscriptionKindDescriptionResult();
083    }
084
085    @Override
086    public SubscriptionKindDescriptionEdit getEdit() {
087        return SubscriptionEditFactory.getSubscriptionKindDescriptionEdit();
088    }
089
090    @Override
091    public SubscriptionKindDescription getEntity(EditSubscriptionKindDescriptionResult result) {
092        SubscriptionKindDescription subscriptionKindDescription = null;
093        var subscriptionKindName = spec.getSubscriptionKindName();
094        var subscriptionKind = subscriptionControl.getSubscriptionKindByName(subscriptionKindName);
095
096        if(subscriptionKind != null) {
097            var languageIsoName = spec.getLanguageIsoName();
098            var language = partyControl.getLanguageByIsoName(languageIsoName);
099
100            if(language != null) {
101                if(editMode.equals(EditMode.LOCK) || editMode.equals(EditMode.ABANDON)) {
102                    subscriptionKindDescription = subscriptionControl.getSubscriptionKindDescription(subscriptionKind, language);
103                } else { // EditMode.UPDATE
104                    subscriptionKindDescription = subscriptionControl.getSubscriptionKindDescriptionForUpdate(subscriptionKind, language);
105                }
106
107                if(subscriptionKindDescription == null) {
108                    addExecutionError(ExecutionErrors.UnknownSubscriptionKindDescription.name(), subscriptionKindName, languageIsoName);
109                }
110            } else {
111                addExecutionError(ExecutionErrors.UnknownLanguageIsoName.name(), languageIsoName);
112            }
113        } else {
114            addExecutionError(ExecutionErrors.UnknownSubscriptionKindName.name(), subscriptionKindName);
115        }
116
117        return subscriptionKindDescription;
118    }
119
120    @Override
121    public SubscriptionKind getLockEntity(SubscriptionKindDescription subscriptionKindDescription) {
122        return subscriptionKindDescription.getSubscriptionKind();
123    }
124
125    @Override
126    public void fillInResult(EditSubscriptionKindDescriptionResult result, SubscriptionKindDescription subscriptionKindDescription) {
127        result.setSubscriptionKindDescription(subscriptionControl.getSubscriptionKindDescriptionTransfer(getUserVisit(), subscriptionKindDescription));
128    }
129
130    @Override
131    public void doLock(SubscriptionKindDescriptionEdit edit, SubscriptionKindDescription subscriptionKindDescription) {
132        edit.setDescription(subscriptionKindDescription.getDescription());
133    }
134
135    @Override
136    public void doUpdate(SubscriptionKindDescription subscriptionKindDescription) {
137        var subscriptionKindDescriptionValue = subscriptionControl.getSubscriptionKindDescriptionValue(subscriptionKindDescription);
138
139        subscriptionKindDescriptionValue.setDescription(edit.getDescription());
140
141        subscriptionControl.updateSubscriptionKindDescriptionFromValue(subscriptionKindDescriptionValue, getPartyPK());
142    }
143
144}