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