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 java.util.List;
046import javax.enterprise.context.Dependent;
047import javax.inject.Inject;
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    @Inject
079    CancellationPolicyControl cancellationPolicyControl;
080
081    @Inject
082    PartyControl partyControl;
083
084    @Inject
085    MimeTypeLogic mimeTypeLogic;
086
087    /** Creates a new instance of EditCancellationPolicyTranslationCommand */
088    public EditCancellationPolicyTranslationCommand() {
089        super(COMMAND_SECURITY_DEFINITION, SPEC_FIELD_DEFINITIONS, EDIT_FIELD_DEFINITIONS);
090    }
091
092    @Override
093    public EditCancellationPolicyTranslationResult getResult() {
094        return CancellationPolicyResultFactory.getEditCancellationPolicyTranslationResult();
095    }
096
097    @Override
098    public CancellationPolicyTranslationEdit getEdit() {
099        return CancellationPolicyEditFactory.getCancellationPolicyTranslationEdit();
100    }
101
102    CancellationKind cancellationKind;
103    
104    @Override
105    public CancellationPolicyTranslation getEntity(EditCancellationPolicyTranslationResult result) {
106        CancellationPolicyTranslation cancellationPolicyTranslation = null;
107        var cancellationKindName = spec.getCancellationKindName();
108        
109        cancellationKind = cancellationPolicyControl.getCancellationKindByName(cancellationKindName);
110
111        if(cancellationKind != null) {
112            var cancellationPolicyName = spec.getCancellationPolicyName();
113            var cancellationPolicy = cancellationPolicyControl.getCancellationPolicyByName(cancellationKind, cancellationPolicyName);
114
115            if(cancellationPolicy != null) {
116                var languageIsoName = spec.getLanguageIsoName();
117                var language = partyControl.getLanguageByIsoName(languageIsoName);
118
119                if(language != null) {
120                    if(editMode.equals(EditMode.LOCK) || editMode.equals(EditMode.ABANDON)) {
121                        cancellationPolicyTranslation = cancellationPolicyControl.getCancellationPolicyTranslation(cancellationPolicy, language);
122                    } else { // EditMode.UPDATE
123                        cancellationPolicyTranslation = cancellationPolicyControl.getCancellationPolicyTranslationForUpdate(cancellationPolicy, language);
124                    }
125
126                    if(cancellationPolicyTranslation == null) {
127                        addExecutionError(ExecutionErrors.UnknownCancellationPolicyTranslation.name(), cancellationKindName, cancellationPolicyName, languageIsoName);
128                    }
129                } else {
130                    addExecutionError(ExecutionErrors.UnknownLanguageIsoName.name(), languageIsoName);
131                }
132            } else {
133                addExecutionError(ExecutionErrors.UnknownCancellationPolicyName.name(), cancellationKindName, cancellationPolicyName);
134            }
135        } else {
136            addExecutionError(ExecutionErrors.UnknownCancellationKindName.name(), cancellationKindName);
137        }
138
139        return cancellationPolicyTranslation;
140    }
141
142    @Override
143    public CancellationPolicy getLockEntity(CancellationPolicyTranslation cancellationPolicyTranslation) {
144        return cancellationPolicyTranslation.getCancellationPolicy();
145    }
146
147    @Override
148    public void fillInResult(EditCancellationPolicyTranslationResult result, CancellationPolicyTranslation cancellationPolicyTranslation) {
149        result.setCancellationPolicyTranslation(cancellationPolicyControl.getCancellationPolicyTranslationTransfer(getUserVisit(), cancellationPolicyTranslation));
150    }
151
152    MimeType policyMimeType;
153    MimeType introductionMimeType;
154    
155    @Override
156    public void doLock(CancellationPolicyTranslationEdit edit, CancellationPolicyTranslation cancellationPolicyTranslation) {
157        policyMimeType = cancellationPolicyTranslation.getPolicyMimeType();
158        
159        edit.setDescription(cancellationPolicyTranslation.getDescription());
160        edit.setPolicyMimeTypeName(policyMimeType == null? null: policyMimeType.getLastDetail().getMimeTypeName());
161        edit.setPolicy(cancellationPolicyTranslation.getPolicy());
162    }
163
164    @Override
165    protected void canUpdate(CancellationPolicyTranslation cancellationPolicyTranslation) {
166        var policyMimeTypeName = edit.getPolicyMimeTypeName();
167        var policy = edit.getPolicy();
168        
169        policyMimeType = mimeTypeLogic.checkMimeType(this, policyMimeTypeName, policy, MimeTypeUsageTypes.TEXT.name(),
170                ExecutionErrors.MissingRequiredPolicyMimeTypeName.name(), ExecutionErrors.MissingRequiredPolicy.name(),
171                ExecutionErrors.UnknownPolicyMimeTypeName.name(), ExecutionErrors.UnknownPolicyMimeTypeUsage.name());
172    }
173    
174    @Override
175    public void doUpdate(CancellationPolicyTranslation cancellationPolicyTranslation) {
176        var cancellationPolicyTranslationValue = cancellationPolicyControl.getCancellationPolicyTranslationValue(cancellationPolicyTranslation);
177        
178        cancellationPolicyTranslationValue.setDescription(edit.getDescription());
179        cancellationPolicyTranslationValue.setPolicyMimeTypePK(policyMimeType == null? null: policyMimeType.getPrimaryKey());
180        cancellationPolicyTranslationValue.setPolicy(edit.getPolicy());
181        
182        cancellationPolicyControl.updateCancellationPolicyTranslationFromValue(cancellationPolicyTranslationValue, getPartyPK());
183    }
184
185}