/**
 * Licensed to Apereo under one or more contributor license
 * agreements. See the NOTICE file distributed with this work
 * for additional information regarding copyright ownership.
 * Apereo licenses this file to you under the Apache License,
 * Version 2.0 (the "License"); you may not use this file
 * except in compliance with the License.  You may obtain a
 * copy of the License at the following location:
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */
package org.apereo.portal.portlets.backgroundpreference;

import javax.portlet.ActionRequest;
import javax.portlet.PortletRequest;

/**
 * Strategy for selecting different background image sets based on some criteria such as theme, user agent, etc.
 *
 * @author James Wennmacher, jwennmacher@unicon.net
 */

public interface BackgroundSetSelectionStrategy {

    String[] getImageSet(PortletRequest req);

    String[] getImageThumbnailSet(PortletRequest req);

    String[] getImageCaptions(PortletRequest req);

    String getSelectedImage(PortletRequest req);

    String getBackgroundContainerSelector(PortletRequest req);

    void setSelectedImage(ActionRequest req, String backgroundImage);

}

/**
 * Licensed to Apereo under one or more contributor license
 * agreements. See the NOTICE file distributed with this work
 * for additional information regarding copyright ownership.
 * Apereo licenses this file to you under the Apache License,
 * Version 2.0 (the "License"); you may not use this file
 * except in compliance with the License.  You may obtain a
 * copy of the License at the following location:
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */
package org.apereo.portal.portlets.backgroundpreference;

import javax.portlet.ActionRequest;
import javax.portlet.PortletRequest;

/**
 * Strategy for selecting different background image sets based on some criteria such as theme, user agent, etc.
 *
 * @author James Wennmacher, jwennmacher@unicon.net
 */

public interface BackgroundSetSelectionStrategy {

    String[] getImageSet(PortletRequest req);

    String[] getImageThumbnailSet(PortletRequest req);

    /**
     * @since 4.3.2
     */
    String[] getImageCaptions(PortletRequest req);

    String getSelectedImage(PortletRequest req);

    String getBackgroundContainerSelector(PortletRequest req);

    void setSelectedImage(ActionRequest req, String backgroundImage);

}

Add since annotation to getImageCaptions
UP-4802: Add since annotation to getImageCaptions
