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.graphql;
018
019import com.echothree.model.control.graphql.server.graphql.BaseEntityInstanceObject;
020import com.echothree.model.control.graphql.server.util.BaseGraphQl;
021import com.echothree.model.control.search.server.control.SearchControl;
022import com.echothree.model.control.user.server.control.UserControl;
023import com.echothree.model.data.search.server.entity.SearchSortOrder;
024import com.echothree.model.data.search.server.entity.SearchSortOrderDetail;
025import com.echothree.util.server.persistence.Session;
026import graphql.annotations.annotationTypes.GraphQLDescription;
027import graphql.annotations.annotationTypes.GraphQLField;
028import graphql.annotations.annotationTypes.GraphQLName;
029import graphql.annotations.annotationTypes.GraphQLNonNull;
030import graphql.schema.DataFetchingEnvironment;
031
032@GraphQLDescription("search sort order object")
033@GraphQLName("SearchSortOrder")
034public class SearchSortOrderObject
035        extends BaseEntityInstanceObject {
036    
037    private final SearchSortOrder searchSortOrder; // Always Present
038    
039    public SearchSortOrderObject(SearchSortOrder searchSortOrder) {
040        super(searchSortOrder.getPrimaryKey());
041        
042        this.searchSortOrder = searchSortOrder;
043    }
044
045    private SearchSortOrderDetail searchSortOrderDetail; // Optional, use getSearchSortOrderDetail()
046    
047    private SearchSortOrderDetail getSearchSortOrderDetail() {
048        if(searchSortOrderDetail == null) {
049            searchSortOrderDetail = searchSortOrder.getLastDetail();
050        }
051        
052        return searchSortOrderDetail;
053    }
054
055    @GraphQLField
056    @GraphQLDescription("search kind")
057    public SearchKindObject getSearchKind(final DataFetchingEnvironment env) {
058        return SearchSecurityUtils.getHasSearchKindAccess(env) ? new SearchKindObject(getSearchSortOrderDetail().getSearchKind()) : null;
059    }
060
061    @GraphQLField
062    @GraphQLDescription("search type name")
063    @GraphQLNonNull
064    public String getSearchSortOrderName() {
065        return getSearchSortOrderDetail().getSearchSortOrderName();
066    }
067    
068    @GraphQLField
069    @GraphQLDescription("is default")
070    @GraphQLNonNull
071    public boolean getIsDefault() {
072        return getSearchSortOrderDetail().getIsDefault();
073    }
074    
075    @GraphQLField
076    @GraphQLDescription("sort order")
077    @GraphQLNonNull
078    public int getSortOrder() {
079        return getSearchSortOrderDetail().getSortOrder();
080    }
081    
082    @GraphQLField
083    @GraphQLDescription("description")
084    @GraphQLNonNull
085    public String getDescription(final DataFetchingEnvironment env) {
086        var searchControl = Session.getModelController(SearchControl.class);
087        var userControl = Session.getModelController(UserControl.class);
088
089        return searchControl.getBestSearchSortOrderDescription(searchSortOrder, userControl.getPreferredLanguageFromUserVisit(BaseGraphQl.getUserVisit(env)));
090    }
091
092}