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.form.GetLinkCardinalityDescriptionForm;
020import com.echothree.control.user.core.common.result.CoreResultFactory;
021import com.echothree.model.control.core.server.control.LinkCardinalityControl;
022import com.echothree.model.control.core.server.logic.LinkCardinalityLogic;
023import com.echothree.model.control.party.common.PartyTypes;
024import com.echothree.model.control.party.server.logic.LanguageLogic;
025import com.echothree.model.control.security.common.SecurityRoleGroups;
026import com.echothree.model.control.security.common.SecurityRoles;
027import com.echothree.model.data.core.server.entity.LinkCardinalityDescription;
028import com.echothree.util.common.command.BaseResult;
029import com.echothree.util.common.message.ExecutionErrors;
030import com.echothree.util.common.validation.FieldDefinition;
031import com.echothree.util.common.validation.FieldType;
032import com.echothree.util.server.control.BaseSingleEntityCommand;
033import com.echothree.util.server.control.CommandSecurityDefinition;
034import com.echothree.util.server.control.PartyTypeDefinition;
035import com.echothree.util.server.control.SecurityRoleDefinition;
036import java.util.List;
037import javax.enterprise.context.Dependent;
038import javax.inject.Inject;
039
040@Dependent
041public class GetLinkCardinalityDescriptionCommand
042        extends BaseSingleEntityCommand<LinkCardinalityDescription, GetLinkCardinalityDescriptionForm> {
043
044    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
045    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
046
047    static {
048        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(List.of(
049                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
050                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
051                        new SecurityRoleDefinition(SecurityRoleGroups.LinkCardinality.name(), SecurityRoles.Description.name())
052                ))
053        ));
054
055        FORM_FIELD_DEFINITIONS = List.of(
056                new FieldDefinition("LinkCardinalityName", FieldType.ENTITY_NAME, true, null, null),
057                new FieldDefinition("LanguageIsoName", FieldType.ENTITY_NAME, true, null, null)
058        );
059    }
060
061    @Inject
062    LinkCardinalityControl linkCardinalityControl;
063
064    @Inject
065    LanguageLogic languageLogic;
066
067    @Inject
068    LinkCardinalityLogic linkCardinalityLogic;
069
070    /** Creates a new instance of GetLinkCardinalityDescriptionCommand */
071    public GetLinkCardinalityDescriptionCommand() {
072        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, true);
073    }
074
075    @Override
076    protected LinkCardinalityDescription getEntity() {
077        LinkCardinalityDescription linkCardinalityDescription = null;
078        var linkCardinalityName = form.getLinkCardinalityName();
079        var linkCardinality = linkCardinalityLogic.getLinkCardinalityByName(this, linkCardinalityName);
080        var languageIsoName = form.getLanguageIsoName();
081        var language = languageLogic.getLanguageByName(this, languageIsoName);
082
083        if(!hasExecutionErrors()) {
084            linkCardinalityDescription = linkCardinalityControl.getLinkCardinalityDescription(linkCardinality, language);
085
086            if(linkCardinalityDescription == null) {
087                addExecutionError(ExecutionErrors.UnknownLinkCardinalityDescription.name(), linkCardinalityName, languageIsoName);
088            }
089        }
090
091        return linkCardinalityDescription;
092    }
093
094    @Override
095    protected BaseResult getResult(LinkCardinalityDescription linkCardinalityDescription) {
096        var result = CoreResultFactory.getGetLinkCardinalityDescriptionResult();
097
098        if(linkCardinalityDescription != null) {
099            result.setLinkCardinalityDescription(linkCardinalityControl.getLinkCardinalityDescriptionTransfer(getUserVisit(), linkCardinalityDescription));
100        }
101
102        return result;
103    }
104
105}