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.result.EditSubscriptionKindResult;
022import com.echothree.control.user.subscription.common.result.SubscriptionResultFactory;
023import com.echothree.control.user.subscription.common.spec.SubscriptionKindSpec;
024import com.echothree.model.control.party.common.PartyTypes;
025import com.echothree.model.control.security.common.SecurityRoleGroups;
026import com.echothree.model.control.security.common.SecurityRoles;
027import com.echothree.model.control.subscription.server.control.SubscriptionControl;
028import com.echothree.model.data.subscription.server.entity.SubscriptionKind;
029import com.echothree.util.common.command.EditMode;
030import com.echothree.util.common.message.ExecutionErrors;
031import com.echothree.util.common.validation.FieldDefinition;
032import com.echothree.util.common.validation.FieldType;
033import com.echothree.util.server.control.BaseAbstractEditCommand;
034import com.echothree.util.server.control.CommandSecurityDefinition;
035import com.echothree.util.server.control.PartyTypeDefinition;
036import com.echothree.util.server.control.SecurityRoleDefinition;
037import java.util.List;
038import javax.enterprise.context.Dependent;
039import javax.inject.Inject;
040
041@Dependent
042public class EditSubscriptionKindCommand
043        extends BaseAbstractEditCommand<SubscriptionKindSpec, SubscriptionKindEdit, EditSubscriptionKindResult, SubscriptionKind, SubscriptionKind> {
044
045    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
046    private final static List<FieldDefinition> SPEC_FIELD_DEFINITIONS;
047    private final static List<FieldDefinition> EDIT_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.SubscriptionKind.name(), SecurityRoles.Edit.name())
054                ))
055        ));
056
057        SPEC_FIELD_DEFINITIONS = List.of(
058                new FieldDefinition("SubscriptionKindName", FieldType.ENTITY_NAME, true, null, null)
059        );
060
061        EDIT_FIELD_DEFINITIONS = List.of(
062                new FieldDefinition("SubscriptionKindName", FieldType.ENTITY_NAME, true, null, null),
063                new FieldDefinition("IsDefault", FieldType.BOOLEAN, true, null, null),
064                new FieldDefinition("SortOrder", FieldType.SIGNED_INTEGER, true, null, null),
065                new FieldDefinition("Description", FieldType.STRING, false, 1L, 132L)
066        );
067    }
068
069    @Inject
070    SubscriptionControl subscriptionControl;
071
072    /** Creates a new instance of EditSubscriptionKindCommand */
073    public EditSubscriptionKindCommand() {
074        super(COMMAND_SECURITY_DEFINITION, SPEC_FIELD_DEFINITIONS, EDIT_FIELD_DEFINITIONS);
075    }
076
077    @Override
078    public EditSubscriptionKindResult getResult() {
079        return SubscriptionResultFactory.getEditSubscriptionKindResult();
080    }
081
082    @Override
083    public SubscriptionKindEdit getEdit() {
084        return SubscriptionEditFactory.getSubscriptionKindEdit();
085    }
086
087    @Override
088    public SubscriptionKind getEntity(EditSubscriptionKindResult result) {
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        result.setSubscriptionKind(subscriptionControl.getSubscriptionKindTransfer(getUserVisit(), subscriptionKind));
113    }
114
115    @Override
116    public void doLock(SubscriptionKindEdit edit, SubscriptionKind subscriptionKind) {
117        var subscriptionKindDescription = subscriptionControl.getSubscriptionKindDescription(subscriptionKind, getPreferredLanguage());
118        var subscriptionKindDetail = subscriptionKind.getLastDetail();
119
120        edit.setSubscriptionKindName(subscriptionKindDetail.getSubscriptionKindName());
121        edit.setIsDefault(subscriptionKindDetail.getIsDefault().toString());
122        edit.setSortOrder(subscriptionKindDetail.getSortOrder().toString());
123
124        if(subscriptionKindDescription != null) {
125            edit.setDescription(subscriptionKindDescription.getDescription());
126        }
127    }
128
129    @Override
130    public void canUpdate(SubscriptionKind subscriptionKind) {
131        var subscriptionKindName = edit.getSubscriptionKindName();
132        var duplicateSubscriptionKind = subscriptionControl.getSubscriptionKindByName(subscriptionKindName);
133
134        if(duplicateSubscriptionKind != null && !subscriptionKind.equals(duplicateSubscriptionKind)) {
135            addExecutionError(ExecutionErrors.DuplicateSubscriptionKindName.name(), subscriptionKindName);
136        }
137    }
138
139    @Override
140    public void doUpdate(SubscriptionKind subscriptionKind) {
141        var partyPK = getPartyPK();
142        var subscriptionKindDetailValue = subscriptionControl.getSubscriptionKindDetailValueForUpdate(subscriptionKind);
143        var subscriptionKindDescription = subscriptionControl.getSubscriptionKindDescriptionForUpdate(subscriptionKind, getPreferredLanguage());
144        var description = edit.getDescription();
145
146        subscriptionKindDetailValue.setSubscriptionKindName(edit.getSubscriptionKindName());
147        subscriptionKindDetailValue.setIsDefault(Boolean.valueOf(edit.getIsDefault()));
148        subscriptionKindDetailValue.setSortOrder(Integer.valueOf(edit.getSortOrder()));
149
150        subscriptionControl.updateSubscriptionKindFromValue(subscriptionKindDetailValue, partyPK);
151
152        if(subscriptionKindDescription == null && description != null) {
153            subscriptionControl.createSubscriptionKindDescription(subscriptionKind, getPreferredLanguage(), description, partyPK);
154        } else if(subscriptionKindDescription != null && description == null) {
155            subscriptionControl.deleteSubscriptionKindDescription(subscriptionKindDescription, partyPK);
156        } else if(subscriptionKindDescription != null && description != null) {
157            var subscriptionKindDescriptionValue = subscriptionControl.getSubscriptionKindDescriptionValue(subscriptionKindDescription);
158
159            subscriptionKindDescriptionValue.setDescription(description);
160            subscriptionControl.updateSubscriptionKindDescriptionFromValue(subscriptionKindDescriptionValue, partyPK);
161        }
162    }
163
164}