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.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;
040
041public class GetSelectorsCommand
042        extends BaseMultipleEntitiesCommand<Selector, GetSelectorsForm> {
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.List.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        );
059    }
060
061    /** Creates a new instance of GetSelectorsCommand */
062    public GetSelectorsCommand(UserVisitPK userVisitPK, GetSelectorsForm form) {
063        super(userVisitPK, form, COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, true);
064    }
065
066    SelectorType selectorType;
067
068    @Override
069    protected Collection<Selector> getEntities() {
070        var selectorControl = Session.getModelController(SelectorControl.class);
071
072        selectorType = SelectorTypeLogic.getInstance().getSelectorTypeByName(this, form.getSelectorKindName(), form.getSelectorTypeName());
073
074        return hasExecutionErrors() ? null : selectorControl.getSelectorsBySelectorType(selectorType);
075    }
076
077    @Override
078    protected BaseResult getResult(Collection<Selector> entities) {
079        var result = SelectorResultFactory.getGetSelectorsResult();
080
081        if(entities != null) {
082            var selectorControl = Session.getModelController(SelectorControl.class);
083
084            if(session.hasLimit(SelectorFactory.class)) {
085                result.setSelectorCount(selectorControl.countSelectorsBySelectorType(selectorType));
086            }
087
088            result.setSelectorType(selectorControl.getSelectorTypeTransfer(getUserVisit(), selectorType));
089            result.setSelectors(selectorControl.getSelectorTransfers(getUserVisit(), entities));
090        }
091
092        return result;
093    }
094
095}