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