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