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.chain.server.command;
018
019import com.echothree.control.user.chain.common.form.GetChainDescriptionsForm;
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.security.common.SecurityRoleGroups;
024import com.echothree.model.control.security.common.SecurityRoles;
025import com.echothree.model.data.user.common.pk.UserVisitPK;
026import com.echothree.util.common.message.ExecutionErrors;
027import com.echothree.util.common.validation.FieldDefinition;
028import com.echothree.util.common.validation.FieldType;
029import com.echothree.util.common.command.BaseResult;
030import com.echothree.util.server.control.BaseSimpleCommand;
031import com.echothree.util.server.control.CommandSecurityDefinition;
032import com.echothree.util.server.control.PartyTypeDefinition;
033import com.echothree.util.server.control.SecurityRoleDefinition;
034import java.util.List;
035import javax.enterprise.context.Dependent;
036import javax.inject.Inject;
037
038@Dependent
039public class GetChainDescriptionsCommand
040        extends BaseSimpleCommand<GetChainDescriptionsForm> {
041    
042    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
043    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
044    
045    static {
046        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(List.of(
047                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
048                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
049                        new SecurityRoleDefinition(SecurityRoleGroups.Chain.name(), SecurityRoles.Description.name())
050                ))
051        ));
052
053        FORM_FIELD_DEFINITIONS = List.of(
054                new FieldDefinition("ChainKindName", FieldType.ENTITY_NAME, true, null, null),
055                new FieldDefinition("ChainTypeName", FieldType.ENTITY_NAME, true, null, null),
056                new FieldDefinition("ChainName", FieldType.ENTITY_NAME, true, null, null)
057        );
058    }
059
060    @Inject
061    ChainControl chainControl;
062
063    
064    /** Creates a new instance of GetChainDescriptionsCommand */
065    public GetChainDescriptionsCommand() {
066        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, true);
067    }
068    
069    @Override
070    protected BaseResult execute() {
071        var result = ChainResultFactory.getGetChainDescriptionsResult();
072        var chainKindName = form.getChainKindName();
073        var chainKind = chainControl.getChainKindByName(chainKindName);
074
075        if(chainKind != null) {
076            var chainTypeName = form.getChainTypeName();
077            var chainType = chainControl.getChainTypeByName(chainKind, chainTypeName);
078
079            if(chainType != null) {
080                var chainName = form.getChainName();
081                var chain = chainControl.getChainByName(chainType, chainName);
082
083                if(chain != null) {
084                    result.setChain(chainControl.getChainTransfer(getUserVisit(), chain));
085                    result.setChainDescriptions(chainControl.getChainDescriptionTransfersByChain(getUserVisit(), chain));
086                } else {
087                    addExecutionError(ExecutionErrors.UnknownChainName.name(), chainKindName, chainTypeName, chainName);
088                }
089            } else {
090                addExecutionError(ExecutionErrors.UnknownChainTypeName.name(), chainKindName, chainTypeName);
091            }
092        } else {
093            addExecutionError(ExecutionErrors.UnknownChainKindName.name(), chainKindName);
094        }
095        
096        return result;
097    }
098    
099}