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.model.control.search.server.logic;
018
019import com.echothree.control.user.search.common.spec.SearchSortOrderUniversalSpec;
020import com.echothree.model.control.core.common.ComponentVendors;
021import com.echothree.model.control.core.common.EntityTypes;
022import com.echothree.model.control.core.common.exception.InvalidParameterCountException;
023import com.echothree.model.control.core.server.logic.EntityInstanceLogic;
024import com.echothree.model.control.search.common.exception.DuplicateSearchSortOrderNameException;
025import com.echothree.model.control.search.common.exception.UnknownDefaultSearchKindException;
026import com.echothree.model.control.search.common.exception.UnknownDefaultSearchSortOrderException;
027import com.echothree.model.control.search.common.exception.UnknownSearchSortOrderNameException;
028import com.echothree.model.control.search.server.control.SearchControl;
029import com.echothree.model.data.party.server.entity.Language;
030import com.echothree.model.data.search.server.entity.SearchKind;
031import com.echothree.model.data.search.server.entity.SearchSortOrder;
032import com.echothree.util.common.message.ExecutionErrors;
033import com.echothree.util.common.persistence.BasePK;
034import com.echothree.util.server.control.BaseLogic;
035import com.echothree.util.server.message.ExecutionErrorAccumulator;
036import com.echothree.util.server.persistence.EntityPermission;
037import com.echothree.util.server.validation.ParameterUtils;
038import javax.enterprise.context.ApplicationScoped;
039import javax.inject.Inject;
040
041@ApplicationScoped
042public class SearchSortOrderLogic
043        extends BaseLogic {
044
045    @Inject
046    SearchControl searchControl;
047
048    @Inject
049    EntityInstanceLogic entityInstanceLogic;
050
051    @Inject
052    SearchKindLogic searchKindLogic;
053
054    protected SearchSortOrderLogic() {
055        super();
056    }
057
058    public SearchSortOrder createSearchSortOrder(final ExecutionErrorAccumulator eea, final String searchKindName, final String searchSortOrderName,
059            final Boolean isDefault, final Integer sortOrder, final Language language, final String description, final BasePK createdBy) {
060        var searchKind = searchKindLogic.getSearchKindByName(eea, searchKindName);
061        SearchSortOrder searchSortOrder = null;
062
063        if(eea == null || !eea.hasExecutionErrors()) {
064            searchSortOrder = createSearchSortOrder(eea, searchKind, searchSortOrderName, isDefault, sortOrder, language, description, createdBy);
065        }
066
067        return searchSortOrder;
068    }
069
070    public SearchSortOrder createSearchSortOrder(final ExecutionErrorAccumulator eea, final SearchKind searchKind, final String searchSortOrderName,
071            final Boolean isDefault, final Integer sortOrder, final Language language, final String description, final BasePK createdBy) {
072        var searchSortOrder = searchControl.getSearchSortOrderByName(searchKind, searchSortOrderName);
073
074        if(searchSortOrder == null) {
075            searchSortOrder = searchControl.createSearchSortOrder(searchKind, searchSortOrderName, isDefault, sortOrder, createdBy);
076
077            if(description != null) {
078                searchControl.createSearchSortOrderDescription(searchSortOrder, language, description, createdBy);
079            }
080        } else {
081            handleExecutionError(DuplicateSearchSortOrderNameException.class, eea, ExecutionErrors.DuplicateSearchSortOrderName.name(), searchSortOrderName);
082        }
083        return searchSortOrder;
084    }
085
086    public SearchSortOrder getSearchSortOrderByName(final ExecutionErrorAccumulator eea, final SearchKind searchKind, final String searchSortOrderName,
087            final EntityPermission entityPermission) {
088        var searchSortOrder = searchControl.getSearchSortOrderByName(searchKind, searchSortOrderName, entityPermission);
089
090        if(searchSortOrder == null) {
091            handleExecutionError(UnknownSearchSortOrderNameException.class, eea, ExecutionErrors.UnknownSearchSortOrderName.name(),
092                    searchKind.getLastDetail().getSearchKindName(), searchSortOrderName);
093        }
094
095        return searchSortOrder;
096    }
097
098    public SearchSortOrder getSearchSortOrderByName(final ExecutionErrorAccumulator eea, final SearchKind searchKind, final String searchSortOrderName) {
099        return getSearchSortOrderByName(eea, searchKind, searchSortOrderName, EntityPermission.READ_ONLY);
100    }
101
102    public SearchSortOrder getSearchSortOrderByNameForUpdate(final ExecutionErrorAccumulator eea, final SearchKind searchKind, final String searchSortOrderName) {
103        return getSearchSortOrderByName(eea, searchKind, searchSortOrderName, EntityPermission.READ_WRITE);
104    }
105
106    public SearchSortOrder getSearchSortOrderByName(final ExecutionErrorAccumulator eea, final String searchKindName, final String searchSortOrderName,
107            final EntityPermission entityPermission) {
108        var searchKind = searchKindLogic.getSearchKindByName(eea, searchKindName);
109        SearchSortOrder searchSortOrder = null;
110
111        if(eea == null || !eea.hasExecutionErrors()) {
112            searchSortOrder = getSearchSortOrderByName(eea, searchKind, searchSortOrderName, entityPermission);
113        }
114
115        return searchSortOrder;
116    }
117
118    public SearchSortOrder getSearchSortOrderByName(final ExecutionErrorAccumulator eea, final String searchKindName, final String searchSortOrderName) {
119        return getSearchSortOrderByName(eea, searchKindName, searchSortOrderName, EntityPermission.READ_ONLY);
120    }
121
122    public SearchSortOrder getSearchSortOrderByNameForUpdate(final ExecutionErrorAccumulator eea, final String searchKindName, final String searchSortOrderName) {
123        return getSearchSortOrderByName(eea, searchKindName, searchSortOrderName, EntityPermission.READ_WRITE);
124    }
125
126    public SearchSortOrder getSearchSortOrderByUniversalSpec(final ExecutionErrorAccumulator eea, final SearchSortOrderUniversalSpec universalSpec,
127            final boolean allowDefault, final EntityPermission entityPermission) {
128        var searchKindName = universalSpec.getSearchKindName();
129        var searchSortOrderName = universalSpec.getSearchSortOrderName();
130        var nameParameterCount= ParameterUtils.getInstance().countNonNullParameters(searchKindName, searchSortOrderName);
131        var possibleEntitySpecs= entityInstanceLogic.countPossibleEntitySpecs(universalSpec);
132        SearchSortOrder searchSortOrder = null;
133
134        if(nameParameterCount < 3 && possibleEntitySpecs == 0) {
135            SearchKind searchKind = null;
136
137            if(searchKindName == null) {
138                if(allowDefault) {
139                    searchKind = searchControl.getDefaultSearchKind();
140
141                    if(searchKind == null) {
142                        handleExecutionError(UnknownDefaultSearchKindException.class, eea, ExecutionErrors.UnknownDefaultSearchKind.name());
143                    }
144                } else {
145                    handleExecutionError(InvalidParameterCountException.class, eea, ExecutionErrors.InvalidParameterCount.name());
146                }
147            } else {
148                searchKind = searchKindLogic.getSearchKindByName(eea, searchKindName);
149            }
150
151            if(eea == null || !eea.hasExecutionErrors()) {
152                if(searchSortOrderName == null) {
153                    if(allowDefault) {
154                        searchSortOrder = searchControl.getDefaultSearchSortOrder(searchKind, entityPermission);
155
156                        if(searchSortOrder == null) {
157                            handleExecutionError(UnknownDefaultSearchSortOrderException.class, eea, ExecutionErrors.UnknownDefaultSearchSortOrder.name());
158                        }
159                    } else {
160                        handleExecutionError(InvalidParameterCountException.class, eea, ExecutionErrors.InvalidParameterCount.name());
161                    }
162                } else {
163                    searchSortOrder = getSearchSortOrderByName(eea, searchKind, searchSortOrderName, entityPermission);
164                }
165            }
166        } else if(nameParameterCount == 0 && possibleEntitySpecs == 1) {
167            var entityInstance = entityInstanceLogic.getEntityInstance(eea, universalSpec,
168                    ComponentVendors.ECHO_THREE.name(), EntityTypes.SearchSortOrder.name());
169
170            if(eea == null || !eea.hasExecutionErrors()) {
171                searchSortOrder = searchControl.getSearchSortOrderByEntityInstance(entityInstance, entityPermission);
172            }
173        } else {
174            handleExecutionError(InvalidParameterCountException.class, eea, ExecutionErrors.InvalidParameterCount.name());
175        }
176
177        return searchSortOrder;
178    }
179
180    public SearchSortOrder getSearchSortOrderByUniversalSpec(final ExecutionErrorAccumulator eea, final SearchSortOrderUniversalSpec universalSpec,
181            boolean allowDefault) {
182        return getSearchSortOrderByUniversalSpec(eea, universalSpec, allowDefault, EntityPermission.READ_ONLY);
183    }
184
185    public SearchSortOrder getSearchSortOrderByUniversalSpecForUpdate(final ExecutionErrorAccumulator eea, final SearchSortOrderUniversalSpec universalSpec,
186            boolean allowDefault) {
187        return getSearchSortOrderByUniversalSpec(eea, universalSpec, allowDefault, EntityPermission.READ_WRITE);
188    }
189
190    public void deleteSearchSortOrder(final ExecutionErrorAccumulator eea, final SearchSortOrder searchSortOrder,
191            final BasePK deletedBy) {
192        searchControl.deleteSearchSortOrder(searchSortOrder, deletedBy);
193    }
194}