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.campaign.server.command;
018
019import com.echothree.control.user.campaign.common.edit.CampaignTermEdit;
020import com.echothree.control.user.campaign.common.edit.CampaignEditFactory;
021import com.echothree.control.user.campaign.common.result.CampaignResultFactory;
022import com.echothree.control.user.campaign.common.result.EditCampaignTermResult;
023import com.echothree.control.user.campaign.common.spec.CampaignTermUniversalSpec;
024import com.echothree.model.control.campaign.server.control.CampaignControl;
025import com.echothree.model.control.campaign.server.logic.CampaignTermLogic;
026import com.echothree.model.control.party.common.PartyTypes;
027import com.echothree.model.control.security.common.SecurityRoleGroups;
028import com.echothree.model.control.security.common.SecurityRoles;
029import com.echothree.model.data.campaign.server.entity.CampaignTerm;
030import com.echothree.util.common.message.ExecutionErrors;
031import com.echothree.util.common.validation.FieldDefinition;
032import com.echothree.util.common.validation.FieldType;
033import com.echothree.util.server.control.BaseAbstractEditCommand;
034import com.echothree.util.server.control.CommandSecurityDefinition;
035import com.echothree.util.server.control.PartyTypeDefinition;
036import com.echothree.util.server.control.SecurityRoleDefinition;
037import java.util.List;
038import javax.enterprise.context.Dependent;
039import javax.inject.Inject;
040
041@Dependent
042public class EditCampaignTermCommand
043        extends BaseAbstractEditCommand<CampaignTermUniversalSpec, CampaignTermEdit, EditCampaignTermResult, CampaignTerm, CampaignTerm> {
044
045    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
046    private final static List<FieldDefinition> SPEC_FIELD_DEFINITIONS;
047    private final static List<FieldDefinition> EDIT_FIELD_DEFINITIONS;
048
049    static {
050        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(List.of(
051                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
052                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
053                        new SecurityRoleDefinition(SecurityRoleGroups.CampaignTerm.name(), SecurityRoles.Edit.name())
054                ))
055        ));
056
057        SPEC_FIELD_DEFINITIONS = List.of(
058                new FieldDefinition("CampaignTermName", FieldType.ENTITY_NAME, false, null, null),
059                new FieldDefinition("EntityRef", FieldType.ENTITY_REF, false, null, null),
060                new FieldDefinition("Uuid", FieldType.UUID, false, null, null)
061        );
062
063        EDIT_FIELD_DEFINITIONS = List.of(
064                new FieldDefinition("Value", FieldType.STRING, true, null, null),
065                new FieldDefinition("IsDefault", FieldType.BOOLEAN, true, null, null),
066                new FieldDefinition("SortOrder", FieldType.SIGNED_INTEGER, true, null, null),
067                new FieldDefinition("Description", FieldType.STRING, false, 1L, 132L)
068        );
069    }
070
071    @Inject
072    CampaignControl campaignControl;
073
074    @Inject
075    CampaignTermLogic campaignTermLogic;
076
077    /** Creates a new instance of EditCampaignTermCommand */
078    public EditCampaignTermCommand() {
079        super(COMMAND_SECURITY_DEFINITION, SPEC_FIELD_DEFINITIONS, EDIT_FIELD_DEFINITIONS);
080    }
081
082    @Override
083    public EditCampaignTermResult getResult() {
084        return CampaignResultFactory.getEditCampaignTermResult();
085    }
086
087    @Override
088    public CampaignTermEdit getEdit() {
089        return CampaignEditFactory.getCampaignTermEdit();
090    }
091
092    @Override
093    public CampaignTerm getEntity(EditCampaignTermResult result) {
094        return campaignTermLogic.getCampaignTermByUniversalSpec(this, spec, editModeToEntityPermission(editMode));
095    }
096
097    @Override
098    public CampaignTerm getLockEntity(CampaignTerm campaignTerm) {
099        return campaignTerm;
100    }
101
102    @Override
103    public void fillInResult(EditCampaignTermResult result, CampaignTerm campaignTerm) {
104        result.setCampaignTerm(campaignControl.getCampaignTermTransfer(getUserVisit(), campaignTerm));
105    }
106
107    @Override
108    public void doLock(CampaignTermEdit edit, CampaignTerm campaignTerm) {
109        var campaignTermDescription = campaignControl.getCampaignTermDescription(campaignTerm, getPreferredLanguage());
110        var campaignTermDetail = campaignTerm.getLastDetail();
111
112        edit.setValue(campaignTermDetail.getValue());
113        edit.setIsDefault(campaignTermDetail.getIsDefault().toString());
114        edit.setSortOrder(campaignTermDetail.getSortOrder().toString());
115
116        if(campaignTermDescription != null) {
117            edit.setDescription(campaignTermDescription.getDescription());
118        }
119    }
120
121    @Override
122    public void canUpdate(CampaignTerm campaignTerm) {
123        var value = edit.getValue();
124        var duplicateCampaignTerm = campaignControl.getCampaignTermByValue(value);
125
126        if(duplicateCampaignTerm != null && !campaignTerm.equals(duplicateCampaignTerm)) {
127            addExecutionError(ExecutionErrors.DuplicateCampaignTermValue.name(), value);
128        }
129    }
130
131    @Override
132    public void doUpdate(CampaignTerm campaignTerm) {
133        var partyPK = getPartyPK();
134        var campaignTermDetailValue = campaignControl.getCampaignTermDetailValueForUpdate(campaignTerm);
135        var campaignTermDescription = campaignControl.getCampaignTermDescriptionForUpdate(campaignTerm, getPreferredLanguage());
136        var description = edit.getDescription();
137
138        campaignTermDetailValue.setValue(edit.getValue());
139        campaignTermDetailValue.setIsDefault(Boolean.valueOf(edit.getIsDefault()));
140        campaignTermDetailValue.setSortOrder(Integer.valueOf(edit.getSortOrder()));
141
142        campaignControl.updateCampaignTermFromValue(campaignTermDetailValue, partyPK);
143
144        if(campaignTermDescription == null && description != null) {
145            campaignControl.createCampaignTermDescription(campaignTerm, getPreferredLanguage(), description, partyPK);
146        } else {
147            if(campaignTermDescription != null && description == null) {
148                campaignControl.deleteCampaignTermDescription(campaignTermDescription, partyPK);
149            } else {
150                if(campaignTermDescription != null && description != null) {
151                    var campaignTermDescriptionValue = campaignControl.getCampaignTermDescriptionValue(campaignTermDescription);
152
153                    campaignTermDescriptionValue.setDescription(description);
154                    campaignControl.updateCampaignTermDescriptionFromValue(campaignTermDescriptionValue, partyPK);
155                }
156            }
157        }
158    }
159
160}