001// --------------------------------------------------------------------------------
002// Copyright 2002-2024 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.transfer;
018
019import com.echothree.model.control.search.common.transfer.SearchKindTransfer;
020import com.echothree.model.control.search.server.control.SearchControl;
021import com.echothree.model.data.search.server.entity.SearchKind;
022import com.echothree.model.data.search.server.entity.SearchKindDetail;
023import com.echothree.model.data.user.server.entity.UserVisit;
024
025public class SearchKindTransferCache
026        extends BaseSearchTransferCache<SearchKind, SearchKindTransfer> {
027    
028    /** Creates a new instance of SearchKindTransferCache */
029    public SearchKindTransferCache(UserVisit userVisit, SearchControl searchControl) {
030        super(userVisit, searchControl);
031        
032        setIncludeEntityInstance(true);
033    }
034    
035    public SearchKindTransfer getSearchKindTransfer(SearchKind searchKind) {
036        SearchKindTransfer searchKindTransfer = get(searchKind);
037        
038        if(searchKindTransfer == null) {
039            SearchKindDetail searchKindDetail = searchKind.getLastDetail();
040            String searchKindName = searchKindDetail.getSearchKindName();
041            Boolean isDefault = searchKindDetail.getIsDefault();
042            Integer sortOrder = searchKindDetail.getSortOrder();
043            String description = searchControl.getBestSearchKindDescription(searchKind, getLanguage());
044            
045            searchKindTransfer = new SearchKindTransfer(searchKindName, isDefault, sortOrder, description);
046            put(searchKind, searchKindTransfer);
047        }
048        
049        return searchKindTransfer;
050    }
051    
052}