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.CancellationPolicyEdit;
020import com.echothree.control.user.cancellationpolicy.common.edit.CancellationPolicyEditFactory;
021import com.echothree.control.user.cancellationpolicy.common.form.EditCancellationPolicyForm;
022import com.echothree.control.user.cancellationpolicy.common.result.CancellationPolicyResultFactory;
023import com.echothree.control.user.cancellationpolicy.common.result.EditCancellationPolicyResult;
024import com.echothree.control.user.cancellationpolicy.common.spec.CancellationPolicySpec;
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.security.common.SecurityRoleGroups;
030import com.echothree.model.control.security.common.SecurityRoles;
031import com.echothree.model.data.cancellationpolicy.server.entity.CancellationKind;
032import com.echothree.model.data.cancellationpolicy.server.entity.CancellationPolicy;
033import com.echothree.model.data.cancellationpolicy.server.entity.CancellationPolicyDetail;
034import com.echothree.model.data.cancellationpolicy.server.entity.CancellationPolicyTranslation;
035import com.echothree.model.data.cancellationpolicy.server.value.CancellationPolicyDetailValue;
036import com.echothree.model.data.cancellationpolicy.server.value.CancellationPolicyTranslationValue;
037import com.echothree.model.data.core.server.entity.MimeType;
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 EditCancellationPolicyCommand
053        extends BaseAbstractEditCommand<CancellationPolicySpec, CancellationPolicyEdit, EditCancellationPolicyResult, CancellationPolicy, 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.Edit.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                ));
071
072        EDIT_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
073                new FieldDefinition("CancellationPolicyName", FieldType.ENTITY_NAME, true, null, null),
074                new FieldDefinition("IsDefault", FieldType.BOOLEAN, true, null, null),
075                new FieldDefinition("SortOrder", FieldType.SIGNED_INTEGER, true, null, null),
076                new FieldDefinition("Description", FieldType.STRING, false, 1L, 132L),
077                new FieldDefinition("PolicyMimeTypeName", FieldType.MIME_TYPE, false, null, null),
078                new FieldDefinition("Policy", FieldType.STRING, false, null, null)
079                ));
080    }
081
082    /** Creates a new instance of EditCancellationPolicyCommand */
083    public EditCancellationPolicyCommand(UserVisitPK userVisitPK, EditCancellationPolicyForm form) {
084        super(userVisitPK, form, COMMAND_SECURITY_DEFINITION, SPEC_FIELD_DEFINITIONS, EDIT_FIELD_DEFINITIONS);
085    }
086
087    @Override
088    public EditCancellationPolicyResult getResult() {
089        return CancellationPolicyResultFactory.getEditCancellationPolicyResult();
090    }
091
092    @Override
093    public CancellationPolicyEdit getEdit() {
094        return CancellationPolicyEditFactory.getCancellationPolicyEdit();
095    }
096
097    CancellationKind cancellationKind;
098
099    @Override
100    public CancellationPolicy getEntity(EditCancellationPolicyResult result) {
101        var cancellationPolicyControl = Session.getModelController(CancellationPolicyControl.class);
102        CancellationPolicy cancellationPolicy = null;
103        String cancellationKindName = spec.getCancellationKindName();
104
105        cancellationKind = cancellationPolicyControl.getCancellationKindByName(cancellationKindName);
106
107        if(cancellationKind != null) {
108            String cancellationPolicyName = spec.getCancellationPolicyName();
109
110            if(editMode.equals(EditMode.LOCK) || editMode.equals(EditMode.ABANDON)) {
111                cancellationPolicy = cancellationPolicyControl.getCancellationPolicyByName(cancellationKind, cancellationPolicyName);
112            } else { // EditMode.UPDATE
113                cancellationPolicy = cancellationPolicyControl.getCancellationPolicyByNameForUpdate(cancellationKind, cancellationPolicyName);
114            }
115
116            if(cancellationPolicy != null) {
117                result.setCancellationPolicy(cancellationPolicyControl.getCancellationPolicyTransfer(getUserVisit(), cancellationPolicy));
118            } else {
119                addExecutionError(ExecutionErrors.UnknownCancellationPolicyName.name(), cancellationKindName, cancellationPolicyName);
120            }
121        } else {
122            addExecutionError(ExecutionErrors.UnknownCancellationKindName.name(), cancellationKindName);
123        }
124
125        return cancellationPolicy;
126    }
127
128    @Override
129    public CancellationPolicy getLockEntity(CancellationPolicy cancellationPolicy) {
130        return cancellationPolicy;
131    }
132
133    @Override
134    public void fillInResult(EditCancellationPolicyResult result, CancellationPolicy cancellationPolicy) {
135        var cancellationPolicyControl = Session.getModelController(CancellationPolicyControl.class);
136
137        result.setCancellationPolicy(cancellationPolicyControl.getCancellationPolicyTransfer(getUserVisit(), cancellationPolicy));
138    }
139
140    MimeType policyMimeType;
141
142    @Override
143    public void doLock(CancellationPolicyEdit edit, CancellationPolicy cancellationPolicy) {
144        var cancellationPolicyControl = Session.getModelController(CancellationPolicyControl.class);
145        CancellationPolicyTranslation cancellationPolicyTranslation = cancellationPolicyControl.getCancellationPolicyTranslation(cancellationPolicy, getPreferredLanguage());
146        CancellationPolicyDetail cancellationPolicyDetail = cancellationPolicy.getLastDetail();
147
148        edit.setCancellationPolicyName(cancellationPolicyDetail.getCancellationPolicyName());
149        edit.setIsDefault(cancellationPolicyDetail.getIsDefault().toString());
150        edit.setSortOrder(cancellationPolicyDetail.getSortOrder().toString());
151
152        if(cancellationPolicyTranslation != null) {
153            policyMimeType = cancellationPolicyTranslation.getPolicyMimeType();
154
155            edit.setDescription(cancellationPolicyTranslation.getDescription());
156            edit.setPolicyMimeTypeName(policyMimeType == null? null: policyMimeType.getLastDetail().getMimeTypeName());
157            edit.setPolicy(cancellationPolicyTranslation.getPolicy());
158        }
159    }
160
161    @Override
162    public void canUpdate(CancellationPolicy cancellationPolicy) {
163        var cancellationPolicyControl = Session.getModelController(CancellationPolicyControl.class);
164        String cancellationPolicyName = edit.getCancellationPolicyName();
165        CancellationPolicy duplicateCancellationPolicy = cancellationPolicyControl.getCancellationPolicyByName(cancellationKind, cancellationPolicyName);
166
167        if(duplicateCancellationPolicy != null && !cancellationPolicy.equals(duplicateCancellationPolicy)) {
168            addExecutionError(ExecutionErrors.DuplicateCancellationPolicyName.name(), cancellationPolicyName);
169        } else {
170            MimeTypeLogic mimeTypeLogic = MimeTypeLogic.getInstance();
171            String policyMimeTypeName = edit.getPolicyMimeTypeName();
172            String policy = edit.getPolicy();
173
174            policyMimeType = mimeTypeLogic.checkMimeType(this, policyMimeTypeName, policy, MimeTypeUsageTypes.TEXT.name(),
175                    ExecutionErrors.MissingRequiredPolicyMimeTypeName.name(), ExecutionErrors.MissingRequiredPolicy.name(),
176                    ExecutionErrors.UnknownPolicyMimeTypeName.name(), ExecutionErrors.UnknownPolicyMimeTypeUsage.name());
177        }
178    }
179
180    @Override
181    public void doUpdate(CancellationPolicy cancellationPolicy) {
182        var cancellationPolicyControl = Session.getModelController(CancellationPolicyControl.class);
183        var partyPK = getPartyPK();
184        CancellationPolicyDetailValue cancellationPolicyDetailValue = cancellationPolicyControl.getCancellationPolicyDetailValueForUpdate(cancellationPolicy);
185        CancellationPolicyTranslation cancellationPolicyTranslation = cancellationPolicyControl.getCancellationPolicyTranslationForUpdate(cancellationPolicy, getPreferredLanguage());
186        String description = edit.getDescription();
187        String policy = edit.getPolicy();
188
189        cancellationPolicyDetailValue.setCancellationPolicyName(edit.getCancellationPolicyName());
190        cancellationPolicyDetailValue.setIsDefault(Boolean.valueOf(edit.getIsDefault()));
191        cancellationPolicyDetailValue.setSortOrder(Integer.valueOf(edit.getSortOrder()));
192
193        cancellationPolicyControl.updateCancellationPolicyFromValue(cancellationPolicyDetailValue, partyPK);
194
195        if(cancellationPolicyTranslation == null && (description != null || policy != null)) {
196            cancellationPolicyControl.createCancellationPolicyTranslation(cancellationPolicy, getPreferredLanguage(), description, policyMimeType, policy,
197                    partyPK);
198        } else if(cancellationPolicyTranslation != null && (description == null && policy == null)) {
199            cancellationPolicyControl.deleteCancellationPolicyTranslation(cancellationPolicyTranslation, partyPK);
200        } else if(cancellationPolicyTranslation != null && (description != null || policy != null)) {
201            CancellationPolicyTranslationValue cancellationPolicyTranslationValue = cancellationPolicyControl.getCancellationPolicyTranslationValue(cancellationPolicyTranslation);
202
203            cancellationPolicyTranslationValue.setDescription(description);
204            cancellationPolicyTranslationValue.setPolicyMimeTypePK(policyMimeType == null? null: policyMimeType.getPrimaryKey());
205            cancellationPolicyTranslationValue.setPolicy(policy);
206            cancellationPolicyControl.updateCancellationPolicyTranslationFromValue(cancellationPolicyTranslationValue, partyPK);
207        }
208    }
209
210}