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.GetSearchSortDirectionsForm;
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.security.common.SecurityRoleGroups;
024import com.echothree.model.control.security.common.SecurityRoles;
025import com.echothree.model.data.search.server.entity.SearchSortDirection;
026import com.echothree.model.data.search.server.factory.SearchSortDirectionFactory;
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.server.control.BasePaginatedMultipleEntitiesCommand;
031import com.echothree.util.server.control.CommandSecurityDefinition;
032import com.echothree.util.server.control.PartyTypeDefinition;
033import com.echothree.util.server.control.SecurityRoleDefinition;
034import com.echothree.util.server.persistence.Session;
035import java.util.Collection;
036import java.util.List;
037import javax.enterprise.context.RequestScoped;
038
039@RequestScoped
040public class GetSearchSortDirectionsCommand
041        extends BasePaginatedMultipleEntitiesCommand<SearchSortDirection, GetSearchSortDirectionsForm> {
042
043    private final static CommandSecurityDefinition COMMAND_SECURITY_DEFINITION;
044    private final static List<FieldDefinition> FORM_FIELD_DEFINITIONS;
045
046    static {
047        COMMAND_SECURITY_DEFINITION = new CommandSecurityDefinition(List.of(
048                new PartyTypeDefinition(PartyTypes.UTILITY.name(), null),
049                new PartyTypeDefinition(PartyTypes.EMPLOYEE.name(), List.of(
050                        new SecurityRoleDefinition(SecurityRoleGroups.SearchSortDirection.name(), SecurityRoles.List.name())
051                ))
052        ));
053
054        FORM_FIELD_DEFINITIONS = List.of();
055    }
056
057    /** Creates a new instance of GetSearchSortDirectionsCommand */
058    public GetSearchSortDirectionsCommand() {
059        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, true);
060    }
061
062    @Override
063    protected void handleForm() {
064        // No form fields.
065    }
066
067    @Override
068    protected Long getTotalEntities() {
069        var searchControl = Session.getModelController(SearchControl.class);
070
071        return searchControl.countSearchSortDirections();
072    }
073
074    @Override
075    protected Collection<SearchSortDirection> getEntities() {
076        var searchControl = Session.getModelController(SearchControl.class);
077
078        return searchControl.getSearchSortDirections();
079    }
080
081    @Override
082    protected BaseResult getResult(Collection<SearchSortDirection> entities) {
083        var result = SearchResultFactory.getGetSearchSortDirectionsResult();
084
085        if(entities != null) {
086            var searchControl = Session.getModelController(SearchControl.class);
087
088            if(session.hasLimit(SearchSortDirectionFactory.class)) {
089                result.setSearchSortDirectionCount(getTotalEntities());
090            }
091
092            result.setSearchSortDirections(searchControl.getSearchSortDirectionTransfers(getUserVisit(), entities));
093        }
094
095        return result;
096    }
097
098}