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.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.core.server.entity.MimeType;
034import com.echothree.model.data.user.common.pk.UserVisitPK;
035import com.echothree.util.common.message.ExecutionErrors;
036import com.echothree.util.common.validation.FieldDefinition;
037import com.echothree.util.common.validation.FieldType;
038import com.echothree.util.common.command.EditMode;
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.List;
045import javax.enterprise.context.Dependent;
046
047@Dependent
048public class EditCancellationPolicyCommand
049        extends BaseAbstractEditCommand<CancellationPolicySpec, CancellationPolicyEdit, EditCancellationPolicyResult, CancellationPolicy, CancellationPolicy> {
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(List.of(
057                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
058                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
059                        new SecurityRoleDefinition(SecurityRoleGroups.CancellationPolicy.name(), SecurityRoles.Edit.name())
060                        ))
061                ));
062
063        SPEC_FIELD_DEFINITIONS = List.of(
064                new FieldDefinition("CancellationKindName", FieldType.ENTITY_NAME, true, null, null),
065                new FieldDefinition("CancellationPolicyName", FieldType.ENTITY_NAME, true, null, null)
066                );
067
068        EDIT_FIELD_DEFINITIONS = List.of(
069                new FieldDefinition("CancellationPolicyName", FieldType.ENTITY_NAME, true, null, null),
070                new FieldDefinition("IsDefault", FieldType.BOOLEAN, true, null, null),
071                new FieldDefinition("SortOrder", FieldType.SIGNED_INTEGER, true, null, null),
072                new FieldDefinition("Description", FieldType.STRING, false, 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 EditCancellationPolicyCommand */
079    public EditCancellationPolicyCommand() {
080        super(COMMAND_SECURITY_DEFINITION, SPEC_FIELD_DEFINITIONS, EDIT_FIELD_DEFINITIONS);
081    }
082
083    @Override
084    public EditCancellationPolicyResult getResult() {
085        return CancellationPolicyResultFactory.getEditCancellationPolicyResult();
086    }
087
088    @Override
089    public CancellationPolicyEdit getEdit() {
090        return CancellationPolicyEditFactory.getCancellationPolicyEdit();
091    }
092
093    CancellationKind cancellationKind;
094
095    @Override
096    public CancellationPolicy getEntity(EditCancellationPolicyResult result) {
097        var cancellationPolicyControl = Session.getModelController(CancellationPolicyControl.class);
098        CancellationPolicy cancellationPolicy = null;
099        var cancellationKindName = spec.getCancellationKindName();
100
101        cancellationKind = cancellationPolicyControl.getCancellationKindByName(cancellationKindName);
102
103        if(cancellationKind != null) {
104            var cancellationPolicyName = spec.getCancellationPolicyName();
105
106            if(editMode.equals(EditMode.LOCK) || editMode.equals(EditMode.ABANDON)) {
107                cancellationPolicy = cancellationPolicyControl.getCancellationPolicyByName(cancellationKind, cancellationPolicyName);
108            } else { // EditMode.UPDATE
109                cancellationPolicy = cancellationPolicyControl.getCancellationPolicyByNameForUpdate(cancellationKind, cancellationPolicyName);
110            }
111
112            if(cancellationPolicy != null) {
113                result.setCancellationPolicy(cancellationPolicyControl.getCancellationPolicyTransfer(getUserVisit(), cancellationPolicy));
114            } else {
115                addExecutionError(ExecutionErrors.UnknownCancellationPolicyName.name(), cancellationKindName, cancellationPolicyName);
116            }
117        } else {
118            addExecutionError(ExecutionErrors.UnknownCancellationKindName.name(), cancellationKindName);
119        }
120
121        return cancellationPolicy;
122    }
123
124    @Override
125    public CancellationPolicy getLockEntity(CancellationPolicy cancellationPolicy) {
126        return cancellationPolicy;
127    }
128
129    @Override
130    public void fillInResult(EditCancellationPolicyResult result, CancellationPolicy cancellationPolicy) {
131        var cancellationPolicyControl = Session.getModelController(CancellationPolicyControl.class);
132
133        result.setCancellationPolicy(cancellationPolicyControl.getCancellationPolicyTransfer(getUserVisit(), cancellationPolicy));
134    }
135
136    MimeType policyMimeType;
137
138    @Override
139    public void doLock(CancellationPolicyEdit edit, CancellationPolicy cancellationPolicy) {
140        var cancellationPolicyControl = Session.getModelController(CancellationPolicyControl.class);
141        var cancellationPolicyTranslation = cancellationPolicyControl.getCancellationPolicyTranslation(cancellationPolicy, getPreferredLanguage());
142        var cancellationPolicyDetail = cancellationPolicy.getLastDetail();
143
144        edit.setCancellationPolicyName(cancellationPolicyDetail.getCancellationPolicyName());
145        edit.setIsDefault(cancellationPolicyDetail.getIsDefault().toString());
146        edit.setSortOrder(cancellationPolicyDetail.getSortOrder().toString());
147
148        if(cancellationPolicyTranslation != null) {
149            policyMimeType = cancellationPolicyTranslation.getPolicyMimeType();
150
151            edit.setDescription(cancellationPolicyTranslation.getDescription());
152            edit.setPolicyMimeTypeName(policyMimeType == null? null: policyMimeType.getLastDetail().getMimeTypeName());
153            edit.setPolicy(cancellationPolicyTranslation.getPolicy());
154        }
155    }
156
157    @Override
158    public void canUpdate(CancellationPolicy cancellationPolicy) {
159        var cancellationPolicyControl = Session.getModelController(CancellationPolicyControl.class);
160        var cancellationPolicyName = edit.getCancellationPolicyName();
161        var duplicateCancellationPolicy = cancellationPolicyControl.getCancellationPolicyByName(cancellationKind, cancellationPolicyName);
162
163        if(duplicateCancellationPolicy != null && !cancellationPolicy.equals(duplicateCancellationPolicy)) {
164            addExecutionError(ExecutionErrors.DuplicateCancellationPolicyName.name(), cancellationPolicyName);
165        } else {
166            var mimeTypeLogic = MimeTypeLogic.getInstance();
167            var policyMimeTypeName = edit.getPolicyMimeTypeName();
168            var policy = edit.getPolicy();
169
170            policyMimeType = mimeTypeLogic.checkMimeType(this, policyMimeTypeName, policy, MimeTypeUsageTypes.TEXT.name(),
171                    ExecutionErrors.MissingRequiredPolicyMimeTypeName.name(), ExecutionErrors.MissingRequiredPolicy.name(),
172                    ExecutionErrors.UnknownPolicyMimeTypeName.name(), ExecutionErrors.UnknownPolicyMimeTypeUsage.name());
173        }
174    }
175
176    @Override
177    public void doUpdate(CancellationPolicy cancellationPolicy) {
178        var cancellationPolicyControl = Session.getModelController(CancellationPolicyControl.class);
179        var partyPK = getPartyPK();
180        var cancellationPolicyDetailValue = cancellationPolicyControl.getCancellationPolicyDetailValueForUpdate(cancellationPolicy);
181        var cancellationPolicyTranslation = cancellationPolicyControl.getCancellationPolicyTranslationForUpdate(cancellationPolicy, getPreferredLanguage());
182        var description = edit.getDescription();
183        var policy = edit.getPolicy();
184
185        cancellationPolicyDetailValue.setCancellationPolicyName(edit.getCancellationPolicyName());
186        cancellationPolicyDetailValue.setIsDefault(Boolean.valueOf(edit.getIsDefault()));
187        cancellationPolicyDetailValue.setSortOrder(Integer.valueOf(edit.getSortOrder()));
188
189        cancellationPolicyControl.updateCancellationPolicyFromValue(cancellationPolicyDetailValue, partyPK);
190
191        if(cancellationPolicyTranslation == null && (description != null || policy != null)) {
192            cancellationPolicyControl.createCancellationPolicyTranslation(cancellationPolicy, getPreferredLanguage(), description, policyMimeType, policy,
193                    partyPK);
194        } else if(cancellationPolicyTranslation != null && (description == null && policy == null)) {
195            cancellationPolicyControl.deleteCancellationPolicyTranslation(cancellationPolicyTranslation, partyPK);
196        } else if(cancellationPolicyTranslation != null && (description != null || policy != null)) {
197            var cancellationPolicyTranslationValue = cancellationPolicyControl.getCancellationPolicyTranslationValue(cancellationPolicyTranslation);
198
199            cancellationPolicyTranslationValue.setDescription(description);
200            cancellationPolicyTranslationValue.setPolicyMimeTypePK(policyMimeType == null? null: policyMimeType.getPrimaryKey());
201            cancellationPolicyTranslationValue.setPolicy(policy);
202            cancellationPolicyControl.updateCancellationPolicyTranslationFromValue(cancellationPolicyTranslationValue, partyPK);
203        }
204    }
205
206}