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