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.CancellationReasonDescriptionEdit;
021import com.echothree.control.user.cancellationpolicy.common.result.CancellationPolicyResultFactory;
022import com.echothree.control.user.cancellationpolicy.common.result.EditCancellationReasonDescriptionResult;
023import com.echothree.control.user.cancellationpolicy.common.spec.CancellationReasonDescriptionSpec;
024import com.echothree.model.control.cancellationpolicy.server.control.CancellationPolicyControl;
025import com.echothree.model.control.cancellationpolicy.server.logic.CancellationKindLogic;
026import com.echothree.model.control.party.common.PartyTypes;
027import com.echothree.model.control.party.server.logic.LanguageLogic;
028import com.echothree.model.control.security.common.SecurityRoleGroups;
029import com.echothree.model.control.security.common.SecurityRoles;
030import com.echothree.model.data.cancellationpolicy.server.entity.CancellationReason;
031import com.echothree.model.data.cancellationpolicy.server.entity.CancellationReasonDescription;
032import com.echothree.util.common.message.ExecutionErrors;
033import com.echothree.util.common.validation.FieldDefinition;
034import com.echothree.util.common.validation.FieldType;
035import com.echothree.util.server.control.BaseAbstractEditCommand;
036import com.echothree.util.server.control.CommandSecurityDefinition;
037import com.echothree.util.server.control.PartyTypeDefinition;
038import com.echothree.util.server.control.SecurityRoleDefinition;
039import java.util.List;
040import javax.enterprise.context.Dependent;
041import javax.inject.Inject;
042
043@Dependent
044public class EditCancellationReasonDescriptionCommand
045        extends BaseAbstractEditCommand<CancellationReasonDescriptionSpec, CancellationReasonDescriptionEdit, EditCancellationReasonDescriptionResult,
046                CancellationReasonDescription, CancellationReason> {
047    
048    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
049    private final static List<FieldDefinition> SPEC_FIELD_DEFINITIONS;
050    private final static List<FieldDefinition> EDIT_FIELD_DEFINITIONS;
051    
052    static {
053        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(List.of(
054                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
055                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
056                        new SecurityRoleDefinition(SecurityRoleGroups.CancellationReason.name(), SecurityRoles.Description.name())
057                ))
058        ));
059        
060        SPEC_FIELD_DEFINITIONS = List.of(
061                new FieldDefinition("CancellationKindName", FieldType.ENTITY_NAME, true, null, null),
062                new FieldDefinition("CancellationReasonName", FieldType.ENTITY_NAME, true, null, null),
063                new FieldDefinition("LanguageIsoName", FieldType.ENTITY_NAME, true, null, null)
064        );
065        
066        EDIT_FIELD_DEFINITIONS = List.of(
067                new FieldDefinition("Description", FieldType.STRING, true, 1L, 132L)
068        );
069    }
070
071    @Inject
072    CancellationPolicyControl cancellationPolicyControl;
073
074    @Inject
075    CancellationKindLogic cancellationKindLogic;
076
077    @Inject
078    LanguageLogic languageLogic;
079    
080    /** Creates a new instance of EditCancellationReasonDescriptionCommand */
081    public EditCancellationReasonDescriptionCommand() {
082        super(COMMAND_SECURITY_DEFINITION, SPEC_FIELD_DEFINITIONS, EDIT_FIELD_DEFINITIONS);
083    }
084    
085    @Override
086    public EditCancellationReasonDescriptionResult getResult() {
087        return CancellationPolicyResultFactory.getEditCancellationReasonDescriptionResult();
088    }
089
090    @Override
091    public CancellationReasonDescriptionEdit getEdit() {
092        return CancellationPolicyEditFactory.getCancellationReasonDescriptionEdit();
093    }
094
095    @Override
096    public CancellationReasonDescription getEntity(EditCancellationReasonDescriptionResult result) {
097        CancellationReasonDescription cancellationReasonDescription = null;
098        var cancellationKindName = spec.getCancellationKindName();
099        var cancellationKind = cancellationKindLogic.getCancellationKindByName(this, cancellationKindName);
100        
101        if(!hasExecutionErrors()) {
102            var cancellationReasonName = spec.getCancellationReasonName();
103            var cancellationReason = cancellationPolicyControl.getCancellationReasonByName(cancellationKind, cancellationReasonName);
104            
105            if(cancellationReason != null) {
106                var languageIsoName = spec.getLanguageIsoName();
107                var language = languageLogic.getLanguageByName(this, languageIsoName);
108                
109                if(!hasExecutionErrors()) {
110                    cancellationReasonDescription = cancellationPolicyControl.getCancellationReasonDescription(cancellationReason, language,
111                            editModeToEntityPermission(editMode));
112
113                    if(cancellationReasonDescription == null) {
114                        addExecutionError(ExecutionErrors.UnknownCancellationReasonDescription.name(), cancellationKindName, cancellationReasonName,
115                                languageIsoName);
116                    }
117                }
118            } else {
119                addExecutionError(ExecutionErrors.UnknownCancellationReasonName.name(), cancellationKindName, cancellationReasonName);
120            }
121        }
122
123        return cancellationReasonDescription;
124    }
125
126    @Override
127    public CancellationReason getLockEntity(CancellationReasonDescription cancellationReasonDescription) {
128        return cancellationReasonDescription.getCancellationReason();
129    }
130
131    @Override
132    public void fillInResult(EditCancellationReasonDescriptionResult result, CancellationReasonDescription cancellationReasonDescription) {
133        result.setCancellationReasonDescription(cancellationPolicyControl.getCancellationReasonDescriptionTransfer(getUserVisit(), cancellationReasonDescription));
134    }
135
136    @Override
137    public void doLock(CancellationReasonDescriptionEdit edit, CancellationReasonDescription cancellationReasonDescription) {
138        edit.setDescription(cancellationReasonDescription.getDescription());
139    }
140
141    @Override
142    public void doUpdate(CancellationReasonDescription cancellationReasonDescription) {
143        var cancellationReasonDescriptionValue = cancellationPolicyControl.getCancellationReasonDescriptionValue(cancellationReasonDescription);
144
145        cancellationReasonDescriptionValue.setDescription(edit.getDescription());
146
147        cancellationPolicyControl.updateCancellationReasonDescriptionFromValue(cancellationReasonDescriptionValue, getPartyPK());
148    }
149    
150}