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.search.server.command;
018
019import com.echothree.control.user.search.common.form.GetEmployeeResultsForm;
020import com.echothree.control.user.search.common.result.SearchResultFactory;
021import com.echothree.model.control.employee.server.control.EmployeeControl;
022import com.echothree.model.control.party.common.PartyTypes;
023import com.echothree.model.control.search.common.SearchKinds;
024import com.echothree.model.control.search.server.logic.SearchLogic;
025import com.echothree.model.control.security.common.SecurityRoleGroups;
026import com.echothree.model.control.security.common.SecurityRoles;
027import com.echothree.model.data.user.common.pk.UserVisitPK;
028import com.echothree.util.common.command.BaseResult;
029import com.echothree.util.common.validation.FieldDefinition;
030import com.echothree.util.common.validation.FieldType;
031import com.echothree.util.server.control.BaseGetResultsCommand;
032import com.echothree.util.server.control.CommandSecurityDefinition;
033import com.echothree.util.server.control.PartyTypeDefinition;
034import com.echothree.util.server.control.SecurityRoleDefinition;
035import com.echothree.util.server.persistence.Session;
036import java.util.List;
037
038public class GetEmployeeResultsCommand
039        extends BaseGetResultsCommand<GetEmployeeResultsForm> {
040
041    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
042    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
043
044    static {
045        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(List.of(
046                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
047                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
048                        new SecurityRoleDefinition(SecurityRoleGroups.Employee.name(), SecurityRoles.Search.name())
049                ))
050        ));
051
052        FORM_FIELD_DEFINITIONS = List.of(
053                new FieldDefinition("SearchTypeName", FieldType.ENTITY_NAME, true, null, null)
054        );
055    }
056
057    /** Creates a new instance of GetEmployeeResultsCommand */
058    public GetEmployeeResultsCommand(UserVisitPK userVisitPK, GetEmployeeResultsForm form) {
059        super(userVisitPK, form, COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, true);
060    }
061
062    @Override
063    protected BaseResult execute() {
064        var result = SearchResultFactory.getGetEmployeeResultsResult();
065        var searchTypeName = form.getSearchTypeName();
066        var userVisit = getUserVisit();
067        var userVisitSearch = SearchLogic.getInstance().getUserVisitSearchByName(this, userVisit,
068                SearchKinds.EMPLOYEE.name(), searchTypeName);
069
070        if(!hasExecutionErrors()) {
071            var employeeControl = Session.getModelController(EmployeeControl.class);
072
073            if(session.hasLimit(com.echothree.model.data.search.server.factory.SearchResultFactory.class)) {
074                result.setEmployeeResultCount(SearchLogic.getInstance().countSearchResults(userVisitSearch.getSearch()));
075            }
076
077            result.setEmployeeResults(employeeControl.getEmployeeResultTransfers(userVisit, userVisitSearch));
078        }
079
080        return result;
081    }
082}