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