001// --------------------------------------------------------------------------------
002// Copyright 2002-2025 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.SelectorResultFactory;
021import com.echothree.model.control.party.common.PartyTypes;
022import com.echothree.model.control.security.common.SecurityRoleGroups;
023import com.echothree.model.control.security.common.SecurityRoles;
024import com.echothree.model.control.selector.server.control.SelectorControl;
025import com.echothree.model.data.user.common.pk.UserVisitPK;
026import com.echothree.util.common.command.BaseResult;
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.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 com.echothree.util.server.persistence.Session;
035import java.util.List;
036import javax.enterprise.context.RequestScoped;
037
038@RequestScoped
039public class GetSelectorDescriptionsCommand
040        extends BaseSimpleCommand<GetSelectorDescriptionsForm> {
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.Selector.name(), SecurityRoles.Description.name())
050                ))
051        ));
052
053        FORM_FIELD_DEFINITIONS = List.of(
054                new FieldDefinition("SelectorKindName", FieldType.ENTITY_NAME, true, null, null),
055                new FieldDefinition("SelectorTypeName", FieldType.ENTITY_NAME, true, null, null),
056                new FieldDefinition("SelectorName", FieldType.ENTITY_NAME, true, null, null)
057        );
058    }
059    
060    /** Creates a new instance of GetSelectorDescriptionsCommand */
061    public GetSelectorDescriptionsCommand() {
062        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, true);
063    }
064    
065    @Override
066    protected BaseResult execute() {
067        var selectorControl = Session.getModelController(SelectorControl.class);
068        var result = SelectorResultFactory.getGetSelectorDescriptionsResult();
069        var selectorKindName = form.getSelectorKindName();
070        var selectorKind = selectorControl.getSelectorKindByName(selectorKindName);
071        
072        if(selectorKind != null) {
073            var selectorTypeName = form.getSelectorTypeName();
074            var selectorType = selectorControl.getSelectorTypeByName(selectorKind, selectorTypeName);
075            
076            result.setSelectorKind(selectorControl.getSelectorKindTransfer(getUserVisit(), selectorKind));
077            
078            if(selectorType != null) {
079                var selectorName = form.getSelectorName();
080                var selector = selectorControl.getSelectorByName(selectorType, selectorName);
081                
082                result.setSelectorType(selectorControl.getSelectorTypeTransfer(getUserVisit(), selectorType));
083                
084                if(selector != null) {
085                    result.setSelector(selectorControl.getSelectorTransfer(getUserVisit(), selector));
086                    result.setSelectorDescriptions(selectorControl.getSelectorDescriptionTransfers(getUserVisit(), selector));
087                } else {
088                    addExecutionError(ExecutionErrors.UnknownSelectorName.name(), selectorName);
089                }
090            } else {
091                addExecutionError(ExecutionErrors.UnknownSelectorTypeName.name(), selectorTypeName);
092            }
093        } else {
094            addExecutionError(ExecutionErrors.UnknownSelectorKindName.name(), selectorKindName);
095        }
096        
097        return result;
098    }
099    
100}