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.search.server.command;
018
019import com.echothree.control.user.search.common.form.GetSearchSortOrdersForm;
020import com.echothree.control.user.search.common.result.SearchResultFactory;
021import com.echothree.model.control.party.common.PartyTypes;
022import com.echothree.model.control.search.server.control.SearchControl;
023import com.echothree.model.control.search.server.logic.SearchKindLogic;
024import com.echothree.model.control.security.common.SecurityRoleGroups;
025import com.echothree.model.control.security.common.SecurityRoles;
026import com.echothree.model.data.search.server.entity.SearchKind;
027import com.echothree.model.data.search.server.entity.SearchSortOrder;
028import com.echothree.model.data.search.server.factory.SearchSortOrderFactory;
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.BasePaginatedMultipleEntitiesCommand;
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 GetSearchSortOrdersCommand
044        extends BasePaginatedMultipleEntitiesCommand<SearchSortOrder, GetSearchSortOrdersForm> {
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.SearchSortOrder.name(), SecurityRoles.List.name())
054                ))
055        ));
056
057        FORM_FIELD_DEFINITIONS = List.of(
058                new FieldDefinition("SearchKindName", FieldType.ENTITY_NAME, true, null, null)
059        );
060    }
061
062    /** Creates a new instance of GetSearchSortOrdersCommand */
063    public GetSearchSortOrdersCommand() {
064        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, true);
065    }
066
067    SearchKind searchKind;
068
069    @Override
070    protected void handleForm() {
071        searchKind = SearchKindLogic.getInstance().getSearchKindByName(this, form.getSearchKindName());
072    }
073
074    @Override
075    protected Long getTotalEntities() {
076        var searchControl = Session.getModelController(SearchControl.class);
077
078        return hasExecutionErrors() ?
079                null :
080                searchControl.countSearchSortOrdersBySearchKind(searchKind);
081    }
082
083    @Override
084    protected Collection<SearchSortOrder> getEntities() {
085        var searchControl = Session.getModelController(SearchControl.class);
086        Collection<SearchSortOrder> entities = null;
087
088        if(!hasExecutionErrors()) {
089            entities = searchControl.getSearchSortOrders(searchKind);
090        }
091
092        return entities;
093    }
094
095    @Override
096    protected BaseResult getResult(Collection<SearchSortOrder> entities) {
097        var result = SearchResultFactory.getGetSearchSortOrdersResult();
098
099        if(entities != null) {
100            var searchControl = Session.getModelController(SearchControl.class);
101            var userVisit = getUserVisit();
102
103            result.setSearchKind(searchControl.getSearchKindTransfer(userVisit, searchKind));
104
105            if(session.hasLimit(SearchSortOrderFactory.class)) {
106                result.setSearchSortOrderCount(searchControl.countSearchSortOrdersBySearchKind(searchKind));
107            }
108
109            result.setSearchSortOrders(searchControl.getSearchSortOrderTransfers(userVisit, entities));
110        }
111
112        return result;
113    }
114
115}