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 com.echothree.util.server.persistence.Session;
038import java.util.List;
039import javax.enterprise.context.Dependent;
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    /** Creates a new instance of EditSubscriptionKindCommand */
070    public EditSubscriptionKindCommand() {
071        super(COMMAND_SECURITY_DEFINITION, SPEC_FIELD_DEFINITIONS, EDIT_FIELD_DEFINITIONS);
072    }
073
074    @Override
075    public EditSubscriptionKindResult getResult() {
076        return SubscriptionResultFactory.getEditSubscriptionKindResult();
077    }
078
079    @Override
080    public SubscriptionKindEdit getEdit() {
081        return SubscriptionEditFactory.getSubscriptionKindEdit();
082    }
083
084    @Override
085    public SubscriptionKind getEntity(EditSubscriptionKindResult result) {
086        var subscriptionControl = Session.getModelController(SubscriptionControl.class);
087        SubscriptionKind subscriptionKind;
088        var subscriptionKindName = spec.getSubscriptionKindName();
089
090        if(editMode.equals(EditMode.LOCK) || editMode.equals(EditMode.ABANDON)) {
091            subscriptionKind = subscriptionControl.getSubscriptionKindByName(subscriptionKindName);
092        } else { // EditMode.UPDATE
093            subscriptionKind = subscriptionControl.getSubscriptionKindByNameForUpdate(subscriptionKindName);
094        }
095
096        if(subscriptionKind == null) {
097            addExecutionError(ExecutionErrors.UnknownSubscriptionKindName.name(), subscriptionKindName);
098        }
099
100        return subscriptionKind;
101    }
102
103    @Override
104    public SubscriptionKind getLockEntity(SubscriptionKind subscriptionKind) {
105        return subscriptionKind;
106    }
107
108    @Override
109    public void fillInResult(EditSubscriptionKindResult result, SubscriptionKind subscriptionKind) {
110        var subscriptionControl = Session.getModelController(SubscriptionControl.class);
111
112        result.setSubscriptionKind(subscriptionControl.getSubscriptionKindTransfer(getUserVisit(), subscriptionKind));
113    }
114
115    @Override
116    public void doLock(SubscriptionKindEdit edit, SubscriptionKind subscriptionKind) {
117        var subscriptionControl = Session.getModelController(SubscriptionControl.class);
118        var subscriptionKindDescription = subscriptionControl.getSubscriptionKindDescription(subscriptionKind, getPreferredLanguage());
119        var subscriptionKindDetail = subscriptionKind.getLastDetail();
120
121        edit.setSubscriptionKindName(subscriptionKindDetail.getSubscriptionKindName());
122        edit.setIsDefault(subscriptionKindDetail.getIsDefault().toString());
123        edit.setSortOrder(subscriptionKindDetail.getSortOrder().toString());
124
125        if(subscriptionKindDescription != null) {
126            edit.setDescription(subscriptionKindDescription.getDescription());
127        }
128    }
129
130    @Override
131    public void canUpdate(SubscriptionKind subscriptionKind) {
132        var subscriptionControl = Session.getModelController(SubscriptionControl.class);
133        var subscriptionKindName = edit.getSubscriptionKindName();
134        var duplicateSubscriptionKind = subscriptionControl.getSubscriptionKindByName(subscriptionKindName);
135
136        if(duplicateSubscriptionKind != null && !subscriptionKind.equals(duplicateSubscriptionKind)) {
137            addExecutionError(ExecutionErrors.DuplicateSubscriptionKindName.name(), subscriptionKindName);
138        }
139    }
140
141    @Override
142    public void doUpdate(SubscriptionKind subscriptionKind) {
143        var subscriptionControl = Session.getModelController(SubscriptionControl.class);
144        var partyPK = getPartyPK();
145        var subscriptionKindDetailValue = subscriptionControl.getSubscriptionKindDetailValueForUpdate(subscriptionKind);
146        var subscriptionKindDescription = subscriptionControl.getSubscriptionKindDescriptionForUpdate(subscriptionKind, getPreferredLanguage());
147        var description = edit.getDescription();
148
149        subscriptionKindDetailValue.setSubscriptionKindName(edit.getSubscriptionKindName());
150        subscriptionKindDetailValue.setIsDefault(Boolean.valueOf(edit.getIsDefault()));
151        subscriptionKindDetailValue.setSortOrder(Integer.valueOf(edit.getSortOrder()));
152
153        subscriptionControl.updateSubscriptionKindFromValue(subscriptionKindDetailValue, partyPK);
154
155        if(subscriptionKindDescription == null && description != null) {
156            subscriptionControl.createSubscriptionKindDescription(subscriptionKind, getPreferredLanguage(), description, partyPK);
157        } else if(subscriptionKindDescription != null && description == null) {
158            subscriptionControl.deleteSubscriptionKindDescription(subscriptionKindDescription, partyPK);
159        } else if(subscriptionKindDescription != null && description != null) {
160            var subscriptionKindDescriptionValue = subscriptionControl.getSubscriptionKindDescriptionValue(subscriptionKindDescription);
161
162            subscriptionKindDescriptionValue.setDescription(description);
163            subscriptionControl.updateSubscriptionKindDescriptionFromValue(subscriptionKindDescriptionValue, partyPK);
164        }
165    }
166
167}