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.core.server.command;
018
019import com.echothree.control.user.core.common.edit.CoreEditFactory;
020import com.echothree.control.user.core.common.edit.LinkCardinalityDescriptionEdit;
021import com.echothree.control.user.core.common.result.CoreResultFactory;
022import com.echothree.control.user.core.common.result.EditLinkCardinalityDescriptionResult;
023import com.echothree.control.user.core.common.spec.LinkCardinalityDescriptionSpec;
024import com.echothree.model.control.core.server.control.LinkCardinalityControl;
025import com.echothree.model.control.core.server.logic.LinkCardinalityLogic;
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.core.server.entity.LinkCardinality;
031import com.echothree.model.data.core.server.entity.LinkCardinalityDescription;
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 EditLinkCardinalityDescriptionCommand
045        extends BaseAbstractEditCommand<LinkCardinalityDescriptionSpec, LinkCardinalityDescriptionEdit, EditLinkCardinalityDescriptionResult, LinkCardinalityDescription, LinkCardinality> {
046
047    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
048    private final static List<FieldDefinition> SPEC_FIELD_DEFINITIONS;
049    private final static List<FieldDefinition> EDIT_FIELD_DEFINITIONS;
050
051    static {
052        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(List.of(
053                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
054                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
055                        new SecurityRoleDefinition(SecurityRoleGroups.LinkCardinality.name(), SecurityRoles.Description.name())
056                ))
057        ));
058
059        SPEC_FIELD_DEFINITIONS = List.of(
060                new FieldDefinition("LinkCardinalityName", FieldType.ENTITY_NAME, true, null, null),
061                new FieldDefinition("LanguageIsoName", FieldType.ENTITY_NAME, true, null, null)
062        );
063
064        EDIT_FIELD_DEFINITIONS = List.of(
065                new FieldDefinition("Description", FieldType.STRING, true, 1L, 132L)
066        );
067    }
068
069    @Inject
070    LinkCardinalityControl linkCardinalityControl;
071
072    @Inject
073    LanguageLogic languageLogic;
074
075    @Inject
076    LinkCardinalityLogic linkCardinalityLogic;
077
078    /** Creates a new instance of EditLinkCardinalityDescriptionCommand */
079    public EditLinkCardinalityDescriptionCommand() {
080        super(COMMAND_SECURITY_DEFINITION, SPEC_FIELD_DEFINITIONS, EDIT_FIELD_DEFINITIONS);
081    }
082
083    @Override
084    public EditLinkCardinalityDescriptionResult getResult() {
085        return CoreResultFactory.getEditLinkCardinalityDescriptionResult();
086    }
087
088    @Override
089    public LinkCardinalityDescriptionEdit getEdit() {
090        return CoreEditFactory.getLinkCardinalityDescriptionEdit();
091    }
092
093    @Override
094    public LinkCardinalityDescription getEntity(EditLinkCardinalityDescriptionResult result) {
095        LinkCardinalityDescription linkCardinalityDescription = null;
096        var linkCardinalityName = spec.getLinkCardinalityName();
097        var linkCardinality = linkCardinalityLogic.getLinkCardinalityByName(this, linkCardinalityName);
098        var languageIsoName = spec.getLanguageIsoName();
099        var language = languageLogic.getLanguageByName(this, languageIsoName);
100
101        if(!hasExecutionErrors()) {
102            linkCardinalityDescription = linkCardinalityControl.getLinkCardinalityDescription(linkCardinality, language,
103                    editModeToEntityPermission(editMode));
104
105            if(linkCardinalityDescription == null) {
106                addExecutionError(ExecutionErrors.UnknownLinkCardinalityDescription.name(), linkCardinalityName, languageIsoName);
107            }
108        }
109
110        return linkCardinalityDescription;
111    }
112
113    @Override
114    public LinkCardinality getLockEntity(LinkCardinalityDescription linkCardinalityDescription) {
115        return linkCardinalityDescription.getLinkCardinality();
116    }
117
118    @Override
119    public void fillInResult(EditLinkCardinalityDescriptionResult result, LinkCardinalityDescription linkCardinalityDescription) {
120        result.setLinkCardinalityDescription(linkCardinalityControl.getLinkCardinalityDescriptionTransfer(getUserVisit(), linkCardinalityDescription));
121    }
122
123    @Override
124    public void doLock(LinkCardinalityDescriptionEdit edit, LinkCardinalityDescription linkCardinalityDescription) {
125        edit.setDescription(linkCardinalityDescription.getDescription());
126    }
127
128    @Override
129    public void doUpdate(LinkCardinalityDescription linkCardinalityDescription) {
130        var linkCardinalityDescriptionValue = linkCardinalityControl.getLinkCardinalityDescriptionValue(linkCardinalityDescription);
131        linkCardinalityDescriptionValue.setDescription(edit.getDescription());
132
133        linkCardinalityControl.updateLinkCardinalityDescriptionFromValue(linkCardinalityDescriptionValue, getPartyPK());
134    }
135
136}