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.cancellationpolicy.server.command;
018
019import com.echothree.control.user.cancellationpolicy.common.edit.CancellationPolicyEditFactory;
020import com.echothree.control.user.cancellationpolicy.common.edit.CancellationPolicyTranslationEdit;
021import com.echothree.control.user.cancellationpolicy.common.form.EditCancellationPolicyTranslationForm;
022import com.echothree.control.user.cancellationpolicy.common.result.CancellationPolicyResultFactory;
023import com.echothree.control.user.cancellationpolicy.common.result.EditCancellationPolicyTranslationResult;
024import com.echothree.control.user.cancellationpolicy.common.spec.CancellationPolicyTranslationSpec;
025import com.echothree.model.control.cancellationpolicy.server.control.CancellationPolicyControl;
026import com.echothree.model.control.core.common.MimeTypeUsageTypes;
027import com.echothree.model.control.core.server.logic.MimeTypeLogic;
028import com.echothree.model.control.party.common.PartyTypes;
029import com.echothree.model.control.party.server.control.PartyControl;
030import com.echothree.model.control.security.common.SecurityRoleGroups;
031import com.echothree.model.control.security.common.SecurityRoles;
032import com.echothree.model.data.cancellationpolicy.server.entity.CancellationKind;
033import com.echothree.model.data.cancellationpolicy.server.entity.CancellationPolicy;
034import com.echothree.model.data.cancellationpolicy.server.entity.CancellationPolicyTranslation;
035import com.echothree.model.data.core.server.entity.MimeType;
036import com.echothree.model.data.user.common.pk.UserVisitPK;
037import com.echothree.util.common.message.ExecutionErrors;
038import com.echothree.util.common.validation.FieldDefinition;
039import com.echothree.util.common.validation.FieldType;
040import com.echothree.util.common.command.EditMode;
041import com.echothree.util.server.control.BaseAbstractEditCommand;
042import com.echothree.util.server.control.CommandSecurityDefinition;
043import com.echothree.util.server.control.PartyTypeDefinition;
044import com.echothree.util.server.control.SecurityRoleDefinition;
045import com.echothree.util.server.persistence.Session;
046import java.util.List;
047import javax.enterprise.context.Dependent;
048
049@Dependent
050public class EditCancellationPolicyTranslationCommand
051        extends BaseAbstractEditCommand<CancellationPolicyTranslationSpec, CancellationPolicyTranslationEdit, EditCancellationPolicyTranslationResult, CancellationPolicyTranslation, CancellationPolicy> {
052
053    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
054    private final static List<FieldDefinition> SPEC_FIELD_DEFINITIONS;
055    private final static List<FieldDefinition> EDIT_FIELD_DEFINITIONS;
056
057    static {
058        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(List.of(
059                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
060                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
061                        new SecurityRoleDefinition(SecurityRoleGroups.CancellationPolicy.name(), SecurityRoles.Translation.name())
062                        ))
063                ));
064
065        SPEC_FIELD_DEFINITIONS = List.of(
066                new FieldDefinition("CancellationKindName", FieldType.ENTITY_NAME, true, null, null),
067                new FieldDefinition("CancellationPolicyName", FieldType.ENTITY_NAME, true, null, null),
068                new FieldDefinition("LanguageIsoName", FieldType.ENTITY_NAME, true, null, null)
069                );
070
071        EDIT_FIELD_DEFINITIONS = List.of(
072                new FieldDefinition("Description", FieldType.STRING, true, 1L, 132L),
073                new FieldDefinition("PolicyMimeTypeName", FieldType.MIME_TYPE, false, null, null),
074                new FieldDefinition("Policy", FieldType.STRING, false, null, null)
075                );
076    }
077
078    /** Creates a new instance of EditCancellationPolicyTranslationCommand */
079    public EditCancellationPolicyTranslationCommand() {
080        super(COMMAND_SECURITY_DEFINITION, SPEC_FIELD_DEFINITIONS, EDIT_FIELD_DEFINITIONS);
081    }
082
083    @Override
084    public EditCancellationPolicyTranslationResult getResult() {
085        return CancellationPolicyResultFactory.getEditCancellationPolicyTranslationResult();
086    }
087
088    @Override
089    public CancellationPolicyTranslationEdit getEdit() {
090        return CancellationPolicyEditFactory.getCancellationPolicyTranslationEdit();
091    }
092
093    CancellationKind cancellationKind;
094    
095    @Override
096    public CancellationPolicyTranslation getEntity(EditCancellationPolicyTranslationResult result) {
097        var cancellationPolicyControl = Session.getModelController(CancellationPolicyControl.class);
098        CancellationPolicyTranslation cancellationPolicyTranslation = null;
099        var cancellationKindName = spec.getCancellationKindName();
100        
101        cancellationKind = cancellationPolicyControl.getCancellationKindByName(cancellationKindName);
102
103        if(cancellationKind != null) {
104            var cancellationPolicyName = spec.getCancellationPolicyName();
105            var cancellationPolicy = cancellationPolicyControl.getCancellationPolicyByName(cancellationKind, cancellationPolicyName);
106
107            if(cancellationPolicy != null) {
108                var partyControl = Session.getModelController(PartyControl.class);
109                var languageIsoName = spec.getLanguageIsoName();
110                var language = partyControl.getLanguageByIsoName(languageIsoName);
111
112                if(language != null) {
113                    if(editMode.equals(EditMode.LOCK) || editMode.equals(EditMode.ABANDON)) {
114                        cancellationPolicyTranslation = cancellationPolicyControl.getCancellationPolicyTranslation(cancellationPolicy, language);
115                    } else { // EditMode.UPDATE
116                        cancellationPolicyTranslation = cancellationPolicyControl.getCancellationPolicyTranslationForUpdate(cancellationPolicy, language);
117                    }
118
119                    if(cancellationPolicyTranslation == null) {
120                        addExecutionError(ExecutionErrors.UnknownCancellationPolicyTranslation.name(), cancellationKindName, cancellationPolicyName, languageIsoName);
121                    }
122                } else {
123                    addExecutionError(ExecutionErrors.UnknownLanguageIsoName.name(), languageIsoName);
124                }
125            } else {
126                addExecutionError(ExecutionErrors.UnknownCancellationPolicyName.name(), cancellationKindName, cancellationPolicyName);
127            }
128        } else {
129            addExecutionError(ExecutionErrors.UnknownCancellationKindName.name(), cancellationKindName);
130        }
131
132        return cancellationPolicyTranslation;
133    }
134
135    @Override
136    public CancellationPolicy getLockEntity(CancellationPolicyTranslation cancellationPolicyTranslation) {
137        return cancellationPolicyTranslation.getCancellationPolicy();
138    }
139
140    @Override
141    public void fillInResult(EditCancellationPolicyTranslationResult result, CancellationPolicyTranslation cancellationPolicyTranslation) {
142        var cancellationPolicyControl = Session.getModelController(CancellationPolicyControl.class);
143
144        result.setCancellationPolicyTranslation(cancellationPolicyControl.getCancellationPolicyTranslationTransfer(getUserVisit(), cancellationPolicyTranslation));
145    }
146
147    MimeType policyMimeType;
148    MimeType introductionMimeType;
149    
150    @Override
151    public void doLock(CancellationPolicyTranslationEdit edit, CancellationPolicyTranslation cancellationPolicyTranslation) {
152        policyMimeType = cancellationPolicyTranslation.getPolicyMimeType();
153        
154        edit.setDescription(cancellationPolicyTranslation.getDescription());
155        edit.setPolicyMimeTypeName(policyMimeType == null? null: policyMimeType.getLastDetail().getMimeTypeName());
156        edit.setPolicy(cancellationPolicyTranslation.getPolicy());
157    }
158
159    @Override
160    protected void canUpdate(CancellationPolicyTranslation cancellationPolicyTranslation) {
161        var mimeTypeLogic = MimeTypeLogic.getInstance();
162        var policyMimeTypeName = edit.getPolicyMimeTypeName();
163        var policy = edit.getPolicy();
164        
165        policyMimeType = mimeTypeLogic.checkMimeType(this, policyMimeTypeName, policy, MimeTypeUsageTypes.TEXT.name(),
166                ExecutionErrors.MissingRequiredPolicyMimeTypeName.name(), ExecutionErrors.MissingRequiredPolicy.name(),
167                ExecutionErrors.UnknownPolicyMimeTypeName.name(), ExecutionErrors.UnknownPolicyMimeTypeUsage.name());
168    }
169    
170    @Override
171    public void doUpdate(CancellationPolicyTranslation cancellationPolicyTranslation) {
172        var cancellationPolicyControl = Session.getModelController(CancellationPolicyControl.class);
173        var cancellationPolicyTranslationValue = cancellationPolicyControl.getCancellationPolicyTranslationValue(cancellationPolicyTranslation);
174        
175        cancellationPolicyTranslationValue.setDescription(edit.getDescription());
176        cancellationPolicyTranslationValue.setPolicyMimeTypePK(policyMimeType == null? null: policyMimeType.getPrimaryKey());
177        cancellationPolicyTranslationValue.setPolicy(edit.getPolicy());
178        
179        cancellationPolicyControl.updateCancellationPolicyTranslationFromValue(cancellationPolicyTranslationValue, getPartyPK());
180    }
181
182}