001/*
002 *  Copyright 2019 Anyware Services
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 */
016package org.ametys.plugins.odfweb.service.search;
017
018import org.apache.cocoon.environment.Request;
019
020import org.ametys.web.frontoffice.search.instance.SearchServiceInstance;
021import org.ametys.web.frontoffice.search.metamodel.Returnable;
022import org.ametys.web.frontoffice.search.requesttime.SearchComponent;
023import org.ametys.web.frontoffice.search.requesttime.SearchComponentArguments;
024
025/**
026 * This {@link SearchComponent} add a join query on acquired skill's id if present
027 */
028public abstract class AbstractSkillSearchComponent implements SearchComponent
029{
030    /** The parameter name for skill search field */
031    protected static final String _SKILL_REQUEST_PARAM_NAME = "skillId";
032    
033    public boolean supports(SearchComponentArguments args)
034    {
035        SearchServiceInstance serviceInstance = args.serviceInstance();
036        return _containsProgramReturnable(serviceInstance);
037    }
038    
039    private boolean _containsProgramReturnable(SearchServiceInstance serviceInstance)
040    {
041        return serviceInstance.getReturnables()
042                .stream()
043                .map(Returnable::getId)
044                .anyMatch(ProgramReturnable.ROLE::equals);
045    }
046    
047    /**
048     * Get the id of searched skill from the request
049     * @param request the request
050     * @return the id of searched skill
051     */
052    protected String _getSkillId(Request request)
053    {
054        return request.getParameter(_SKILL_REQUEST_PARAM_NAME);
055    }
056}