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.GetChainForm;
020import com.echothree.control.user.chain.common.result.ChainResultFactory;
021import com.echothree.model.control.chain.server.control.ChainControl;
022import com.echothree.model.control.core.common.EventTypes;
023import com.echothree.model.control.party.common.PartyTypes;
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.List;
037import javax.enterprise.context.Dependent;
038
039@Dependent
040public class GetChainCommand
041        extends BaseSimpleCommand<GetChainForm> {
042    
043    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
044    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
045    
046    static {
047        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(List.of(
048                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
049                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
050                    new SecurityRoleDefinition(SecurityRoleGroups.Chain.name(), SecurityRoles.Review.name())
051                    ))
052                ));
053
054        FORM_FIELD_DEFINITIONS = List.of(
055                new FieldDefinition("ChainKindName", FieldType.ENTITY_NAME, true, null, null),
056                new FieldDefinition("ChainTypeName", FieldType.ENTITY_NAME, true, null, null),
057                new FieldDefinition("ChainName", FieldType.ENTITY_NAME, true, null, null)
058                );
059    }
060    
061    /** Creates a new instance of GetChainCommand */
062    public GetChainCommand() {
063        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, true);
064    }
065    
066    @Override
067    protected BaseResult execute() {
068        var chainControl = Session.getModelController(ChainControl.class);
069        var result = ChainResultFactory.getGetChainResult();
070        var chainKindName = form.getChainKindName();
071        var chainKind = chainControl.getChainKindByName(chainKindName);
072        
073        if(chainKind != null) {
074            var chainTypeName = form.getChainTypeName();
075            var chainType = chainControl.getChainTypeByName(chainKind, chainTypeName);
076
077            if(chainType != null) {
078                var chainName = form.getChainName();
079                var chain = chainControl.getChainByName(chainType, chainName);
080
081                if(chain != null) {
082                    result.setChain(chainControl.getChainTransfer(getUserVisit(), chain));
083
084                    sendEvent(chain.getPrimaryKey(), EventTypes.READ, null, null, getPartyPK());
085                } else {
086                    addExecutionError(ExecutionErrors.UnknownChainName.name(), chainKindName, chainTypeName, chainName);
087                }
088            } else {
089                addExecutionError(ExecutionErrors.UnknownChainTypeName.name(), chainKindName, chainTypeName);
090            }
091        } else {
092            addExecutionError(ExecutionErrors.UnknownChainKindName.name(), chainKindName);
093        }
094        
095        return result;
096    }
097    
098}