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 com.echothree.util.server.persistence.Session;
040import java.util.List;
041import javax.enterprise.context.Dependent;
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    /** Creates a new instance of EditSubscriptionKindDescriptionCommand */
070    public EditSubscriptionKindDescriptionCommand() {
071        super(COMMAND_SECURITY_DEFINITION, SPEC_FIELD_DEFINITIONS, EDIT_FIELD_DEFINITIONS);
072    }
073
074    @Override
075    public EditSubscriptionKindDescriptionResult getResult() {
076        return SubscriptionResultFactory.getEditSubscriptionKindDescriptionResult();
077    }
078
079    @Override
080    public SubscriptionKindDescriptionEdit getEdit() {
081        return SubscriptionEditFactory.getSubscriptionKindDescriptionEdit();
082    }
083
084    @Override
085    public SubscriptionKindDescription getEntity(EditSubscriptionKindDescriptionResult result) {
086        var subscriptionControl = Session.getModelController(SubscriptionControl.class);
087        SubscriptionKindDescription subscriptionKindDescription = null;
088        var subscriptionKindName = spec.getSubscriptionKindName();
089        var subscriptionKind = subscriptionControl.getSubscriptionKindByName(subscriptionKindName);
090
091        if(subscriptionKind != null) {
092            var partyControl = Session.getModelController(PartyControl.class);
093            var languageIsoName = spec.getLanguageIsoName();
094            var language = partyControl.getLanguageByIsoName(languageIsoName);
095
096            if(language != null) {
097                if(editMode.equals(EditMode.LOCK) || editMode.equals(EditMode.ABANDON)) {
098                    subscriptionKindDescription = subscriptionControl.getSubscriptionKindDescription(subscriptionKind, language);
099                } else { // EditMode.UPDATE
100                    subscriptionKindDescription = subscriptionControl.getSubscriptionKindDescriptionForUpdate(subscriptionKind, language);
101                }
102
103                if(subscriptionKindDescription == null) {
104                    addExecutionError(ExecutionErrors.UnknownSubscriptionKindDescription.name(), subscriptionKindName, languageIsoName);
105                }
106            } else {
107                addExecutionError(ExecutionErrors.UnknownLanguageIsoName.name(), languageIsoName);
108            }
109        } else {
110            addExecutionError(ExecutionErrors.UnknownSubscriptionKindName.name(), subscriptionKindName);
111        }
112
113        return subscriptionKindDescription;
114    }
115
116    @Override
117    public SubscriptionKind getLockEntity(SubscriptionKindDescription subscriptionKindDescription) {
118        return subscriptionKindDescription.getSubscriptionKind();
119    }
120
121    @Override
122    public void fillInResult(EditSubscriptionKindDescriptionResult result, SubscriptionKindDescription subscriptionKindDescription) {
123        var subscriptionControl = Session.getModelController(SubscriptionControl.class);
124
125        result.setSubscriptionKindDescription(subscriptionControl.getSubscriptionKindDescriptionTransfer(getUserVisit(), subscriptionKindDescription));
126    }
127
128    @Override
129    public void doLock(SubscriptionKindDescriptionEdit edit, SubscriptionKindDescription subscriptionKindDescription) {
130        edit.setDescription(subscriptionKindDescription.getDescription());
131    }
132
133    @Override
134    public void doUpdate(SubscriptionKindDescription subscriptionKindDescription) {
135        var subscriptionControl = Session.getModelController(SubscriptionControl.class);
136        var subscriptionKindDescriptionValue = subscriptionControl.getSubscriptionKindDescriptionValue(subscriptionKindDescription);
137
138        subscriptionKindDescriptionValue.setDescription(edit.getDescription());
139
140        subscriptionControl.updateSubscriptionKindDescriptionFromValue(subscriptionKindDescriptionValue, getPartyPK());
141    }
142
143}