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.selector.server.command;
018
019import com.echothree.control.user.selector.common.form.GetSelectorDescriptionsForm;
020import com.echothree.control.user.selector.common.result.GetSelectorDescriptionsResult;
021import com.echothree.control.user.selector.common.result.SelectorResultFactory;
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.control.selector.server.control.SelectorControl;
026import com.echothree.model.data.selector.server.entity.Selector;
027import com.echothree.model.data.selector.server.entity.SelectorKind;
028import com.echothree.model.data.selector.server.entity.SelectorType;
029import com.echothree.model.data.user.common.pk.UserVisitPK;
030import com.echothree.util.common.command.BaseResult;
031import com.echothree.util.common.message.ExecutionErrors;
032import com.echothree.util.common.validation.FieldDefinition;
033import com.echothree.util.common.validation.FieldType;
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.List;
040
041public class GetSelectorDescriptionsCommand
042        extends BaseSimpleCommand<GetSelectorDescriptionsForm> {
043
044    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
045    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
046    
047    static {
048        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(List.of(
049                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
050                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
051                        new SecurityRoleDefinition(SecurityRoleGroups.Selector.name(), SecurityRoles.Description.name())
052                ))
053        ));
054
055        FORM_FIELD_DEFINITIONS = List.of(
056                new FieldDefinition("SelectorKindName", FieldType.ENTITY_NAME, true, null, null),
057                new FieldDefinition("SelectorTypeName", FieldType.ENTITY_NAME, true, null, null),
058                new FieldDefinition("SelectorName", FieldType.ENTITY_NAME, true, null, null)
059        );
060    }
061    
062    /** Creates a new instance of GetSelectorDescriptionsCommand */
063    public GetSelectorDescriptionsCommand(UserVisitPK userVisitPK, GetSelectorDescriptionsForm form) {
064        super(userVisitPK, form, COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, true);
065    }
066    
067    @Override
068    protected BaseResult execute() {
069        var selectorControl = Session.getModelController(SelectorControl.class);
070        GetSelectorDescriptionsResult result = SelectorResultFactory.getGetSelectorDescriptionsResult();
071        String selectorKindName = form.getSelectorKindName();
072        SelectorKind selectorKind = selectorControl.getSelectorKindByName(selectorKindName);
073        
074        if(selectorKind != null) {
075            String selectorTypeName = form.getSelectorTypeName();
076            SelectorType selectorType = selectorControl.getSelectorTypeByName(selectorKind, selectorTypeName);
077            
078            result.setSelectorKind(selectorControl.getSelectorKindTransfer(getUserVisit(), selectorKind));
079            
080            if(selectorType != null) {
081                String selectorName = form.getSelectorName();
082                Selector selector = selectorControl.getSelectorByName(selectorType, selectorName);
083                
084                result.setSelectorType(selectorControl.getSelectorTypeTransfer(getUserVisit(), selectorType));
085                
086                if(selector != null) {
087                    result.setSelector(selectorControl.getSelectorTransfer(getUserVisit(), selector));
088                    result.setSelectorDescriptions(selectorControl.getSelectorDescriptionTransfers(getUserVisit(), selector));
089                } else {
090                    addExecutionError(ExecutionErrors.UnknownSelectorName.name(), selectorName);
091                }
092            } else {
093                addExecutionError(ExecutionErrors.UnknownSelectorTypeName.name(), selectorTypeName);
094            }
095        } else {
096            addExecutionError(ExecutionErrors.UnknownSelectorKindName.name(), selectorKindName);
097        }
098        
099        return result;
100    }
101    
102}