001// --------------------------------------------------------------------------------
002// Copyright 2002-2026 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 java.util.Collection;
038import java.util.List;
039import javax.enterprise.context.Dependent;
040import javax.inject.Inject;
041
042@Dependent
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    @Inject
063    SearchControl searchControl;
064
065    @Inject
066    SearchKindLogic searchKindLogic;
067
068    /** Creates a new instance of GetSearchSortOrdersCommand */
069    public GetSearchSortOrdersCommand() {
070        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, true);
071    }
072
073    SearchKind searchKind;
074
075    @Override
076    protected void handleForm() {
077        searchKind = searchKindLogic.getSearchKindByName(this, form.getSearchKindName());
078    }
079
080    @Override
081    protected Long getTotalEntities() {
082        return hasExecutionErrors() ?
083                null :
084                searchControl.countSearchSortOrdersBySearchKind(searchKind);
085    }
086
087    @Override
088    protected Collection<SearchSortOrder> getEntities() {
089        Collection<SearchSortOrder> entities = null;
090
091        if(!hasExecutionErrors()) {
092            entities = searchControl.getSearchSortOrders(searchKind);
093        }
094
095        return entities;
096    }
097
098    @Override
099    protected BaseResult getResult(Collection<SearchSortOrder> entities) {
100        var result = SearchResultFactory.getGetSearchSortOrdersResult();
101
102        if(entities != null) {
103            var userVisit = getUserVisit();
104
105            result.setSearchKind(searchControl.getSearchKindTransfer(userVisit, searchKind));
106
107            if(session.hasLimit(SearchSortOrderFactory.class)) {
108                result.setSearchSortOrderCount(searchControl.countSearchSortOrdersBySearchKind(searchKind));
109            }
110
111            result.setSearchSortOrders(searchControl.getSearchSortOrderTransfers(userVisit, entities));
112        }
113
114        return result;
115    }
116
117}