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.chain.server.command;
018
019import com.echothree.control.user.chain.common.form.GetChainDescriptionForm;
020import com.echothree.control.user.chain.common.result.ChainResultFactory;
021import com.echothree.model.control.chain.server.control.ChainControl;
022import com.echothree.model.control.party.common.PartyTypes;
023import com.echothree.model.control.party.server.control.PartyControl;
024import com.echothree.model.control.security.common.SecurityRoleGroups;
025import com.echothree.model.control.security.common.SecurityRoles;
026import com.echothree.model.data.user.common.pk.UserVisitPK;
027import com.echothree.util.common.message.ExecutionErrors;
028import com.echothree.util.common.validation.FieldDefinition;
029import com.echothree.util.common.validation.FieldType;
030import com.echothree.util.common.command.BaseResult;
031import com.echothree.util.server.control.BaseSimpleCommand;
032import com.echothree.util.server.control.CommandSecurityDefinition;
033import com.echothree.util.server.control.PartyTypeDefinition;
034import com.echothree.util.server.control.SecurityRoleDefinition;
035import com.echothree.util.server.persistence.Session;
036import java.util.Arrays;
037import java.util.Collections;
038import java.util.List;
039import javax.enterprise.context.RequestScoped;
040
041@RequestScoped
042public class GetChainDescriptionCommand
043        extends BaseSimpleCommand<GetChainDescriptionForm> {
044    
045    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
046    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
047    
048    static {
049        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(Collections.unmodifiableList(Arrays.asList(
050                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
051                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), Collections.unmodifiableList(Arrays.asList(
052                        new SecurityRoleDefinition(SecurityRoleGroups.Chain.name(), SecurityRoles.Description.name())
053                        )))
054                )));
055        
056        FORM_FIELD_DEFINITIONS = Collections.unmodifiableList(Arrays.asList(
057                new FieldDefinition("ChainKindName", FieldType.ENTITY_NAME, true, null, null),
058                new FieldDefinition("ChainTypeName", FieldType.ENTITY_NAME, true, null, null),
059                new FieldDefinition("ChainName", FieldType.ENTITY_NAME, true, null, null),
060                new FieldDefinition("LanguageIsoName", FieldType.ENTITY_NAME, true, null, null)
061                ));
062    }
063    
064    /** Creates a new instance of GetChainDescriptionCommand */
065    public GetChainDescriptionCommand() {
066        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, false);
067    }
068    
069    @Override
070    protected BaseResult execute() {
071        var chainControl = Session.getModelController(ChainControl.class);
072        var result = ChainResultFactory.getGetChainDescriptionResult();
073        var chainKindName = form.getChainKindName();
074        var chainKind = chainControl.getChainKindByName(chainKindName);
075
076        if(chainKind != null) {
077            var chainTypeName = form.getChainTypeName();
078            var chainType = chainControl.getChainTypeByName(chainKind, chainTypeName);
079
080            if(chainType != null) {
081                var chainName = form.getChainName();
082                var chain = chainControl.getChainByName(chainType, chainName);
083
084                if(chain != null) {
085                    var partyControl = Session.getModelController(PartyControl.class);
086                    var languageIsoName = form.getLanguageIsoName();
087                    var language = partyControl.getLanguageByIsoName(languageIsoName);
088
089                    if(language != null) {
090                        var chainDescription = chainControl.getChainDescription(chain, language);
091
092                        if(chainDescription != null) {
093                            result.setChainDescription(chainControl.getChainDescriptionTransfer(getUserVisit(), chainDescription));
094                        } else {
095                            addExecutionError(ExecutionErrors.UnknownChainDescription.name(), chainKindName, chainTypeName, chainName, languageIsoName);
096                        }
097                    } else {
098                        addExecutionError(ExecutionErrors.UnknownLanguageIsoName.name(), languageIsoName);
099                    }
100                } else {
101                    addExecutionError(ExecutionErrors.UnknownChainName.name(), chainKindName, chainTypeName, chainName);
102                }
103            } else {
104                addExecutionError(ExecutionErrors.UnknownChainTypeName.name(), chainKindName, chainTypeName);
105            }
106        } else {
107            addExecutionError(ExecutionErrors.UnknownChainKindName.name(), chainKindName);
108        }
109
110        return result;
111    }
112    
113}