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