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.SearchKindUniversalSpec;
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.DuplicateSearchKindNameException;
025import com.echothree.model.control.search.common.exception.UnknownDefaultSearchKindException;
026import com.echothree.model.control.search.common.exception.UnknownSearchKindNameException;
027import com.echothree.model.control.search.server.control.SearchControl;
028import com.echothree.model.data.party.server.entity.Language;
029import com.echothree.model.data.search.server.entity.SearchKind;
030import com.echothree.util.common.message.ExecutionErrors;
031import com.echothree.util.common.persistence.BasePK;
032import com.echothree.util.server.control.BaseLogic;
033import com.echothree.util.server.message.ExecutionErrorAccumulator;
034import com.echothree.util.server.persistence.EntityPermission;
035import javax.enterprise.context.ApplicationScoped;
036import javax.enterprise.inject.spi.CDI;
037import javax.inject.Inject;
038
039@ApplicationScoped
040public class SearchKindLogic
041        extends BaseLogic {
042
043    @Inject
044    SearchControl searchControl;
045
046    @Inject
047    EntityInstanceLogic entityInstanceLogic;
048
049    protected SearchKindLogic() {
050        super();
051    }
052
053    public static SearchKindLogic getInstance() {
054        return CDI.current().select(SearchKindLogic.class).get();
055    }
056
057    public SearchKind createSearchKind(final ExecutionErrorAccumulator eea, final String searchKindName,
058            final Boolean isDefault, final Integer sortOrder, final Language language, final String description,
059            final BasePK createdBy) {
060        var searchKind = searchControl.getSearchKindByName(searchKindName);
061
062        if(searchKind == null) {
063            searchKind = searchControl.createSearchKind(searchKindName, isDefault, sortOrder, createdBy);
064
065            if(description != null) {
066                searchControl.createSearchKindDescription(searchKind, language, description, createdBy);
067            }
068        } else {
069            handleExecutionError(DuplicateSearchKindNameException.class, eea, ExecutionErrors.DuplicateSearchKindName.name(), searchKindName);
070        }
071
072        return searchKind;
073    }
074
075    public SearchKind getSearchKindByName(final ExecutionErrorAccumulator eea, final String searchKindName,
076            final EntityPermission entityPermission) {
077        var searchKind = searchControl.getSearchKindByName(searchKindName, entityPermission);
078
079        if(searchKind == null) {
080            handleExecutionError(UnknownSearchKindNameException.class, eea, ExecutionErrors.UnknownSearchKindName.name(), searchKindName);
081        }
082
083        return searchKind;
084    }
085
086    public SearchKind getSearchKindByName(final ExecutionErrorAccumulator eea, final String searchKindName) {
087        return getSearchKindByName(eea, searchKindName, EntityPermission.READ_ONLY);
088    }
089
090    public SearchKind getSearchKindByNameForUpdate(final ExecutionErrorAccumulator eea, final String searchKindName) {
091        return getSearchKindByName(eea, searchKindName, EntityPermission.READ_WRITE);
092    }
093
094    public SearchKind getSearchKindByUniversalSpec(final ExecutionErrorAccumulator eea,
095            final SearchKindUniversalSpec universalSpec, boolean allowDefault, final EntityPermission entityPermission) {
096        SearchKind searchKind = null;
097        var searchKindName = universalSpec.getSearchKindName();
098        var parameterCount = (searchKindName == null ? 0 : 1) + entityInstanceLogic.countPossibleEntitySpecs(universalSpec);
099
100        switch(parameterCount) {
101            case 0 -> {
102                if(allowDefault) {
103                    searchKind = searchControl.getDefaultSearchKind(entityPermission);
104
105                    if(searchKind == null) {
106                        handleExecutionError(UnknownDefaultSearchKindException.class, eea, ExecutionErrors.UnknownDefaultSearchKind.name());
107                    }
108                } else {
109                    handleExecutionError(InvalidParameterCountException.class, eea, ExecutionErrors.InvalidParameterCount.name());
110                }
111            }
112            case 1 -> {
113                if(searchKindName == null) {
114                    var entityInstance = entityInstanceLogic.getEntityInstance(eea, universalSpec,
115                            ComponentVendors.ECHO_THREE.name(), EntityTypes.SearchKind.name());
116
117                    if(eea == null || !eea.hasExecutionErrors()) {
118                        searchKind = searchControl.getSearchKindByEntityInstance(entityInstance, entityPermission);
119                    }
120                } else {
121                    searchKind = getSearchKindByName(eea, searchKindName, entityPermission);
122                }
123            }
124            default ->
125                    handleExecutionError(InvalidParameterCountException.class, eea, ExecutionErrors.InvalidParameterCount.name());
126        }
127
128        return searchKind;
129    }
130
131    public SearchKind getSearchKindByUniversalSpec(final ExecutionErrorAccumulator eea,
132            final SearchKindUniversalSpec universalSpec, boolean allowDefault) {
133        return getSearchKindByUniversalSpec(eea, universalSpec, allowDefault, EntityPermission.READ_ONLY);
134    }
135
136    public SearchKind getSearchKindByUniversalSpecForUpdate(final ExecutionErrorAccumulator eea,
137            final SearchKindUniversalSpec universalSpec, boolean allowDefault) {
138        return getSearchKindByUniversalSpec(eea, universalSpec, allowDefault, EntityPermission.READ_WRITE);
139    }
140
141    public void deleteSearchKind(final ExecutionErrorAccumulator eea, final SearchKind searchKind,
142            final BasePK deletedBy) {
143        searchControl.deleteSearchKind(searchKind, deletedBy);
144    }
145
146}