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.model.control.search.server.logic;
018
019import com.echothree.control.user.search.common.spec.SearchSortDirectionUniversalSpec;
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.DuplicateSearchSortDirectionNameException;
025import com.echothree.model.control.search.common.exception.UnknownDefaultSearchSortDirectionException;
026import com.echothree.model.control.search.common.exception.UnknownSearchSortDirectionNameException;
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.SearchSortDirection;
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 com.echothree.util.server.persistence.Session;
036import javax.enterprise.context.ApplicationScoped;
037import javax.enterprise.inject.spi.CDI;
038
039@ApplicationScoped
040public class SearchSortDirectionLogic
041        extends BaseLogic {
042
043    protected SearchSortDirectionLogic() {
044        super();
045    }
046
047    public static SearchSortDirectionLogic getInstance() {
048        return CDI.current().select(SearchSortDirectionLogic.class).get();
049    }
050
051    public SearchSortDirection createSearchSortDirection(final ExecutionErrorAccumulator eea, final String searchSortDirectionName,
052            final Boolean isDefault, final Integer sortOrder, final Language language, final String description,
053            final BasePK createdBy) {
054        var searchControl = Session.getModelController(SearchControl.class);
055        var searchSortDirection = searchControl.getSearchSortDirectionByName(searchSortDirectionName);
056
057        if(searchSortDirection == null) {
058            searchSortDirection = searchControl.createSearchSortDirection(searchSortDirectionName, isDefault, sortOrder, createdBy);
059
060            if(description != null) {
061                searchControl.createSearchSortDirectionDescription(searchSortDirection, language, description, createdBy);
062            }
063        } else {
064            handleExecutionError(DuplicateSearchSortDirectionNameException.class, eea, ExecutionErrors.DuplicateSearchSortDirectionName.name(), searchSortDirectionName);
065        }
066
067        return searchSortDirection;
068    }
069
070    public SearchSortDirection getSearchSortDirectionByName(final ExecutionErrorAccumulator eea, final String searchSortDirectionName,
071            final EntityPermission entityPermission) {
072        var searchControl = Session.getModelController(SearchControl.class);
073        var searchSortDirection = searchControl.getSearchSortDirectionByName(searchSortDirectionName, entityPermission);
074
075        if(searchSortDirection == null) {
076            handleExecutionError(UnknownSearchSortDirectionNameException.class, eea, ExecutionErrors.UnknownSearchSortDirectionName.name(), searchSortDirectionName);
077        }
078
079        return searchSortDirection;
080    }
081
082    public SearchSortDirection getSearchSortDirectionByName(final ExecutionErrorAccumulator eea, final String searchSortDirectionName) {
083        return getSearchSortDirectionByName(eea, searchSortDirectionName, EntityPermission.READ_ONLY);
084    }
085
086    public SearchSortDirection getSearchSortDirectionByNameForUpdate(final ExecutionErrorAccumulator eea, final String searchSortDirectionName) {
087        return getSearchSortDirectionByName(eea, searchSortDirectionName, EntityPermission.READ_WRITE);
088    }
089
090    public SearchSortDirection getSearchSortDirectionByUniversalSpec(final ExecutionErrorAccumulator eea,
091            final SearchSortDirectionUniversalSpec universalSpec, boolean allowDefault, final EntityPermission entityPermission) {
092        SearchSortDirection searchSortDirection = null;
093        var searchControl = Session.getModelController(SearchControl.class);
094        var searchSortDirectionName = universalSpec.getSearchSortDirectionName();
095        var parameterCount = (searchSortDirectionName == null ? 0 : 1) + EntityInstanceLogic.getInstance().countPossibleEntitySpecs(universalSpec);
096
097        switch(parameterCount) {
098            case 0 -> {
099                if(allowDefault) {
100                    searchSortDirection = searchControl.getDefaultSearchSortDirection(entityPermission);
101
102                    if(searchSortDirection == null) {
103                        handleExecutionError(UnknownDefaultSearchSortDirectionException.class, eea, ExecutionErrors.UnknownDefaultSearchSortDirection.name());
104                    }
105                } else {
106                    handleExecutionError(InvalidParameterCountException.class, eea, ExecutionErrors.InvalidParameterCount.name());
107                }
108            }
109            case 1 -> {
110                if(searchSortDirectionName == null) {
111                    var entityInstance = EntityInstanceLogic.getInstance().getEntityInstance(eea, universalSpec,
112                            ComponentVendors.ECHO_THREE.name(), EntityTypes.SearchSortDirection.name());
113
114                    if(!eea.hasExecutionErrors()) {
115                        searchSortDirection = searchControl.getSearchSortDirectionByEntityInstance(entityInstance, entityPermission);
116                    }
117                } else {
118                    searchSortDirection = getSearchSortDirectionByName(eea, searchSortDirectionName, entityPermission);
119                }
120            }
121            default ->
122                    handleExecutionError(InvalidParameterCountException.class, eea, ExecutionErrors.InvalidParameterCount.name());
123        }
124
125        return searchSortDirection;
126    }
127
128    public SearchSortDirection getSearchSortDirectionByUniversalSpec(final ExecutionErrorAccumulator eea,
129            final SearchSortDirectionUniversalSpec universalSpec, boolean allowDefault) {
130        return getSearchSortDirectionByUniversalSpec(eea, universalSpec, allowDefault, EntityPermission.READ_ONLY);
131    }
132
133    public SearchSortDirection getSearchSortDirectionByUniversalSpecForUpdate(final ExecutionErrorAccumulator eea,
134            final SearchSortDirectionUniversalSpec universalSpec, boolean allowDefault) {
135        return getSearchSortDirectionByUniversalSpec(eea, universalSpec, allowDefault, EntityPermission.READ_WRITE);
136    }
137
138    public void deleteSearchSortDirection(final ExecutionErrorAccumulator eea, final SearchSortDirection searchSortDirection,
139            final BasePK deletedBy) {
140        var searchControl = Session.getModelController(SearchControl.class);
141
142        searchControl.deleteSearchSortDirection(searchSortDirection, deletedBy);
143    }
144
145}