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.SubscriptionKindEdit;
021import com.echothree.control.user.subscription.common.form.EditSubscriptionKindForm;
022import com.echothree.control.user.subscription.common.result.EditSubscriptionKindResult;
023import com.echothree.control.user.subscription.common.result.SubscriptionResultFactory;
024import com.echothree.control.user.subscription.common.spec.SubscriptionKindSpec;
025import com.echothree.model.control.party.common.PartyTypes;
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.user.common.pk.UserVisitPK;
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.common.command.EditMode;
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 EditSubscriptionKindCommand
045        extends BaseAbstractEditCommand<SubscriptionKindSpec, SubscriptionKindEdit, EditSubscriptionKindResult, SubscriptionKind, 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.Edit.name())
056                        ))
057                ));
058
059        SPEC_FIELD_DEFINITIONS = List.of(
060                new FieldDefinition("SubscriptionKindName", FieldType.ENTITY_NAME, true, null, null)
061                );
062
063        EDIT_FIELD_DEFINITIONS = List.of(
064                new FieldDefinition("SubscriptionKindName", FieldType.ENTITY_NAME, true, null, null),
065                new FieldDefinition("IsDefault", FieldType.BOOLEAN, true, null, null),
066                new FieldDefinition("SortOrder", FieldType.SIGNED_INTEGER, true, null, null),
067                new FieldDefinition("Description", FieldType.STRING, false, 1L, 132L)
068                );
069    }
070
071    /** Creates a new instance of EditSubscriptionKindCommand */
072    public EditSubscriptionKindCommand() {
073        super(COMMAND_SECURITY_DEFINITION, SPEC_FIELD_DEFINITIONS, EDIT_FIELD_DEFINITIONS);
074    }
075
076    @Override
077    public EditSubscriptionKindResult getResult() {
078        return SubscriptionResultFactory.getEditSubscriptionKindResult();
079    }
080
081    @Override
082    public SubscriptionKindEdit getEdit() {
083        return SubscriptionEditFactory.getSubscriptionKindEdit();
084    }
085
086    @Override
087    public SubscriptionKind getEntity(EditSubscriptionKindResult result) {
088        var subscriptionControl = Session.getModelController(SubscriptionControl.class);
089        SubscriptionKind subscriptionKind;
090        var subscriptionKindName = spec.getSubscriptionKindName();
091
092        if(editMode.equals(EditMode.LOCK) || editMode.equals(EditMode.ABANDON)) {
093            subscriptionKind = subscriptionControl.getSubscriptionKindByName(subscriptionKindName);
094        } else { // EditMode.UPDATE
095            subscriptionKind = subscriptionControl.getSubscriptionKindByNameForUpdate(subscriptionKindName);
096        }
097
098        if(subscriptionKind == null) {
099            addExecutionError(ExecutionErrors.UnknownSubscriptionKindName.name(), subscriptionKindName);
100        }
101
102        return subscriptionKind;
103    }
104
105    @Override
106    public SubscriptionKind getLockEntity(SubscriptionKind subscriptionKind) {
107        return subscriptionKind;
108    }
109
110    @Override
111    public void fillInResult(EditSubscriptionKindResult result, SubscriptionKind subscriptionKind) {
112        var subscriptionControl = Session.getModelController(SubscriptionControl.class);
113
114        result.setSubscriptionKind(subscriptionControl.getSubscriptionKindTransfer(getUserVisit(), subscriptionKind));
115    }
116
117    @Override
118    public void doLock(SubscriptionKindEdit edit, SubscriptionKind subscriptionKind) {
119        var subscriptionControl = Session.getModelController(SubscriptionControl.class);
120        var subscriptionKindDescription = subscriptionControl.getSubscriptionKindDescription(subscriptionKind, getPreferredLanguage());
121        var subscriptionKindDetail = subscriptionKind.getLastDetail();
122
123        edit.setSubscriptionKindName(subscriptionKindDetail.getSubscriptionKindName());
124        edit.setIsDefault(subscriptionKindDetail.getIsDefault().toString());
125        edit.setSortOrder(subscriptionKindDetail.getSortOrder().toString());
126
127        if(subscriptionKindDescription != null) {
128            edit.setDescription(subscriptionKindDescription.getDescription());
129        }
130    }
131
132    @Override
133    public void canUpdate(SubscriptionKind subscriptionKind) {
134        var subscriptionControl = Session.getModelController(SubscriptionControl.class);
135        var subscriptionKindName = edit.getSubscriptionKindName();
136        var duplicateSubscriptionKind = subscriptionControl.getSubscriptionKindByName(subscriptionKindName);
137
138        if(duplicateSubscriptionKind != null && !subscriptionKind.equals(duplicateSubscriptionKind)) {
139            addExecutionError(ExecutionErrors.DuplicateSubscriptionKindName.name(), subscriptionKindName);
140        }
141    }
142
143    @Override
144    public void doUpdate(SubscriptionKind subscriptionKind) {
145        var subscriptionControl = Session.getModelController(SubscriptionControl.class);
146        var partyPK = getPartyPK();
147        var subscriptionKindDetailValue = subscriptionControl.getSubscriptionKindDetailValueForUpdate(subscriptionKind);
148        var subscriptionKindDescription = subscriptionControl.getSubscriptionKindDescriptionForUpdate(subscriptionKind, getPreferredLanguage());
149        var description = edit.getDescription();
150
151        subscriptionKindDetailValue.setSubscriptionKindName(edit.getSubscriptionKindName());
152        subscriptionKindDetailValue.setIsDefault(Boolean.valueOf(edit.getIsDefault()));
153        subscriptionKindDetailValue.setSortOrder(Integer.valueOf(edit.getSortOrder()));
154
155        subscriptionControl.updateSubscriptionKindFromValue(subscriptionKindDetailValue, partyPK);
156
157        if(subscriptionKindDescription == null && description != null) {
158            subscriptionControl.createSubscriptionKindDescription(subscriptionKind, getPreferredLanguage(), description, partyPK);
159        } else if(subscriptionKindDescription != null && description == null) {
160            subscriptionControl.deleteSubscriptionKindDescription(subscriptionKindDescription, partyPK);
161        } else if(subscriptionKindDescription != null && description != null) {
162            var subscriptionKindDescriptionValue = subscriptionControl.getSubscriptionKindDescriptionValue(subscriptionKindDescription);
163
164            subscriptionKindDescriptionValue.setDescription(description);
165            subscriptionControl.updateSubscriptionKindDescriptionFromValue(subscriptionKindDescriptionValue, partyPK);
166        }
167    }
168
169}