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.payment.server.command;
018
019import com.echothree.control.user.payment.common.edit.PaymentEditFactory;
020import com.echothree.control.user.payment.common.edit.PaymentMethodDescriptionEdit;
021import com.echothree.control.user.payment.common.form.EditPaymentMethodDescriptionForm;
022import com.echothree.control.user.payment.common.result.EditPaymentMethodDescriptionResult;
023import com.echothree.control.user.payment.common.result.PaymentResultFactory;
024import com.echothree.control.user.payment.common.spec.PaymentMethodDescriptionSpec;
025import com.echothree.model.control.party.common.PartyTypes;
026import com.echothree.model.control.party.server.control.PartyControl;
027import com.echothree.model.control.payment.server.control.PaymentMethodControl;
028import com.echothree.model.control.security.common.SecurityRoleGroups;
029import com.echothree.model.control.security.common.SecurityRoles;
030import com.echothree.model.data.party.server.entity.Language;
031import com.echothree.model.data.payment.server.entity.PaymentMethod;
032import com.echothree.model.data.payment.server.entity.PaymentMethodDescription;
033import com.echothree.model.data.payment.server.value.PaymentMethodDescriptionValue;
034import com.echothree.model.data.user.common.pk.UserVisitPK;
035import com.echothree.util.common.command.EditMode;
036import com.echothree.util.common.message.ExecutionErrors;
037import com.echothree.util.common.validation.FieldDefinition;
038import com.echothree.util.common.validation.FieldType;
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 EditPaymentMethodDescriptionCommand
049        extends BaseAbstractEditCommand<PaymentMethodDescriptionSpec, PaymentMethodDescriptionEdit, EditPaymentMethodDescriptionResult, PaymentMethodDescription, PaymentMethod> {
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.PaymentMethod.name(), SecurityRoles.Description.name())
060                    )))
061                )));
062
063        SPEC_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
064                new FieldDefinition("PaymentMethodName", FieldType.ENTITY_NAME, true, null, null),
065                new FieldDefinition("LanguageIsoName", FieldType.ENTITY_NAME, true, null, null)
066                ));
067
068        EDIT_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
069                new FieldDefinition("Description", FieldType.STRING, true, 1L, 132L)
070                ));
071    }
072
073    /** Creates a new instance of EditPaymentMethodDescriptionCommand */
074    public EditPaymentMethodDescriptionCommand(UserVisitPK userVisitPK, EditPaymentMethodDescriptionForm form) {
075        super(userVisitPK, form, COMMAND_SECURITY_DEFINITION, SPEC_FIELD_DEFINITIONS, EDIT_FIELD_DEFINITIONS);
076    }
077
078    @Override
079    public EditPaymentMethodDescriptionResult getResult() {
080        return PaymentResultFactory.getEditPaymentMethodDescriptionResult();
081    }
082
083    @Override
084    public PaymentMethodDescriptionEdit getEdit() {
085        return PaymentEditFactory.getPaymentMethodDescriptionEdit();
086    }
087
088    @Override
089    public PaymentMethodDescription getEntity(EditPaymentMethodDescriptionResult result) {
090        var paymentMethodControl = Session.getModelController(PaymentMethodControl.class);
091        PaymentMethodDescription paymentMethodDescription = null;
092        String paymentMethodName = spec.getPaymentMethodName();
093        PaymentMethod paymentMethod = paymentMethodControl.getPaymentMethodByName(paymentMethodName);
094
095        if(paymentMethod != null) {
096            var partyControl = Session.getModelController(PartyControl.class);
097            String languageIsoName = spec.getLanguageIsoName();
098            Language language = partyControl.getLanguageByIsoName(languageIsoName);
099
100            if(language != null) {
101                if(editMode.equals(EditMode.LOCK) || editMode.equals(EditMode.ABANDON)) {
102                    paymentMethodDescription = paymentMethodControl.getPaymentMethodDescription(paymentMethod, language);
103                } else { // EditMode.UPDATE
104                    paymentMethodDescription = paymentMethodControl.getPaymentMethodDescriptionForUpdate(paymentMethod, language);
105                }
106
107                if(paymentMethodDescription == null) {
108                    addExecutionError(ExecutionErrors.UnknownPaymentMethodDescription.name(), paymentMethodName, languageIsoName);
109                }
110            } else {
111                addExecutionError(ExecutionErrors.UnknownLanguageIsoName.name(), languageIsoName);
112            }
113        } else {
114            addExecutionError(ExecutionErrors.UnknownPaymentMethodName.name(), paymentMethodName);
115        }
116
117        return paymentMethodDescription;
118    }
119
120    @Override
121    public PaymentMethod getLockEntity(PaymentMethodDescription paymentMethodDescription) {
122        return paymentMethodDescription.getPaymentMethod();
123    }
124
125    @Override
126    public void fillInResult(EditPaymentMethodDescriptionResult result, PaymentMethodDescription paymentMethodDescription) {
127        var paymentMethodControl = Session.getModelController(PaymentMethodControl.class);
128
129        result.setPaymentMethodDescription(paymentMethodControl.getPaymentMethodDescriptionTransfer(getUserVisit(), paymentMethodDescription));
130    }
131
132    @Override
133    public void doLock(PaymentMethodDescriptionEdit edit, PaymentMethodDescription paymentMethodDescription) {
134        edit.setDescription(paymentMethodDescription.getDescription());
135    }
136
137    @Override
138    public void doUpdate(PaymentMethodDescription paymentMethodDescription) {
139        var paymentMethodControl = Session.getModelController(PaymentMethodControl.class);
140        PaymentMethodDescriptionValue paymentMethodDescriptionValue = paymentMethodControl.getPaymentMethodDescriptionValue(paymentMethodDescription);
141        paymentMethodDescriptionValue.setDescription(edit.getDescription());
142
143        paymentMethodControl.updatePaymentMethodDescriptionFromValue(paymentMethodDescriptionValue, getPartyPK());
144    }
145
146}