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.GetSelectorsForm;
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.control.selector.server.logic.SelectorTypeLogic;
026import com.echothree.model.data.selector.server.entity.Selector;
027import com.echothree.model.data.selector.server.entity.SelectorType;
028import com.echothree.model.data.selector.server.factory.SelectorFactory;
029import com.echothree.model.data.user.common.pk.UserVisitPK;
030import com.echothree.util.common.command.BaseResult;
031import com.echothree.util.common.validation.FieldDefinition;
032import com.echothree.util.common.validation.FieldType;
033import com.echothree.util.server.control.BaseMultipleEntitiesCommand;
034import com.echothree.util.server.control.CommandSecurityDefinition;
035import com.echothree.util.server.control.PartyTypeDefinition;
036import com.echothree.util.server.control.SecurityRoleDefinition;
037import com.echothree.util.server.persistence.Session;
038import java.util.Collection;
039import java.util.List;
040import javax.enterprise.context.RequestScoped;
041
042@RequestScoped
043public class GetSelectorsCommand
044        extends BaseMultipleEntitiesCommand<Selector, GetSelectorsForm> {
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(List.of(
051                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
052                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
053                        new SecurityRoleDefinition(SecurityRoleGroups.Selector.name(), SecurityRoles.List.name())
054                ))
055        ));
056
057        FORM_FIELD_DEFINITIONS = List.of(
058                new FieldDefinition("SelectorKindName", FieldType.ENTITY_NAME, true, null, null),
059                new FieldDefinition("SelectorTypeName", FieldType.ENTITY_NAME, true, null, null)
060        );
061    }
062
063    /** Creates a new instance of GetSelectorsCommand */
064    public GetSelectorsCommand() {
065        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, true);
066    }
067
068    SelectorType selectorType;
069
070    @Override
071    protected Collection<Selector> getEntities() {
072        var selectorControl = Session.getModelController(SelectorControl.class);
073
074        selectorType = SelectorTypeLogic.getInstance().getSelectorTypeByName(this, form.getSelectorKindName(), form.getSelectorTypeName());
075
076        return hasExecutionErrors() ? null : selectorControl.getSelectorsBySelectorType(selectorType);
077    }
078
079    @Override
080    protected BaseResult getResult(Collection<Selector> entities) {
081        var result = SelectorResultFactory.getGetSelectorsResult();
082
083        if(entities != null) {
084            var selectorControl = Session.getModelController(SelectorControl.class);
085
086            if(session.hasLimit(SelectorFactory.class)) {
087                result.setSelectorCount(selectorControl.countSelectorsBySelectorType(selectorType));
088            }
089
090            result.setSelectorType(selectorControl.getSelectorTypeTransfer(getUserVisit(), selectorType));
091            result.setSelectors(selectorControl.getSelectorTransfers(getUserVisit(), entities));
092        }
093
094        return result;
095    }
096
097}