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.GetSearchSortOrderForm;
020import com.echothree.control.user.search.common.result.SearchResultFactory;
021import com.echothree.model.control.core.common.EventTypes;
022import com.echothree.model.control.party.common.PartyTypes;
023import com.echothree.model.control.search.server.control.SearchControl;
024import com.echothree.model.control.search.server.logic.SearchSortOrderLogic;
025import com.echothree.model.control.security.common.SecurityRoleGroups;
026import com.echothree.model.control.security.common.SecurityRoles;
027import com.echothree.model.data.search.server.entity.SearchSortOrder;
028import com.echothree.model.data.user.common.pk.UserVisitPK;
029import com.echothree.util.common.command.BaseResult;
030import com.echothree.util.common.validation.FieldDefinition;
031import com.echothree.util.common.validation.FieldType;
032import com.echothree.util.server.control.BaseSingleEntityCommand;
033import com.echothree.util.server.control.CommandSecurityDefinition;
034import com.echothree.util.server.control.PartyTypeDefinition;
035import com.echothree.util.server.control.SecurityRoleDefinition;
036import com.echothree.util.server.persistence.Session;
037import java.util.List;
038import javax.enterprise.context.RequestScoped;
039
040@RequestScoped
041public class GetSearchSortOrderCommand
042        extends BaseSingleEntityCommand<SearchSortOrder, GetSearchSortOrderForm> {
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.SearchSortOrder.name(), SecurityRoles.Review.name())
052                ))
053        ));
054
055        FORM_FIELD_DEFINITIONS = List.of(
056                new FieldDefinition("SearchKindName", FieldType.ENTITY_NAME, false, null, null),
057                new FieldDefinition("SearchSortOrderName", FieldType.ENTITY_NAME, false, null, null),
058                new FieldDefinition("EntityRef", FieldType.ENTITY_REF, false, null, null),
059                new FieldDefinition("Uuid", FieldType.UUID, false, null, null)
060        );
061    }
062
063    /** Creates a new instance of GetSearchSortOrderCommand */
064    public GetSearchSortOrderCommand() {
065        super(COMMAND_SECURITY_DEFINITION, FORM_FIELD_DEFINITIONS, true);
066    }
067
068    @Override
069    protected SearchSortOrder getEntity() {
070        var searchSortOrder = SearchSortOrderLogic.getInstance().getSearchSortOrderByUniversalSpec(this, form, true);
071
072        if(searchSortOrder != null) {
073            sendEvent(searchSortOrder.getPrimaryKey(), EventTypes.READ, null, null, getPartyPK());
074        }
075
076        return searchSortOrder;
077    }
078
079    @Override
080    protected BaseResult getResult(SearchSortOrder searchSortOrder) {
081        var searchControl = Session.getModelController(SearchControl.class);
082        var result = SearchResultFactory.getGetSearchSortOrderResult();
083
084        if(searchSortOrder != null) {
085            result.setSearchSortOrder(searchControl.getSearchSortOrderTransfer(getUserVisit(), searchSortOrder));
086        }
087
088        return result;
089    }
090
091}