/**
 * 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:
 *
 * <p>http://www.apache.org/licenses/LICENSE-2.0
 *
 * <p>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.portlet.registry;

import java.util.concurrent.locks.Lock;
import javax.servlet.http.HttpServletRequest;
import org.apereo.portal.portlet.om.IPortletDefinitionId;
import org.apereo.portal.portlet.om.IPortletEntity;
import org.apereo.portal.portlet.om.IPortletEntityId;
import org.apereo.portal.portlet.om.IPortletWindowId;
import org.apereo.portal.user.IUserInstance;

/**
 * Provides methods for creating and accessing {@link IPortletEntity} and related objects.
 */
public interface IPortletEntityRegistry {
    /**
     * @param portletEntityId The ID of the portlet entity to get a lock for
     * @return The Lock for the Portlet Entity
     */
    public Lock getPortletEntityLock(HttpServletRequest request, IPortletEntityId portletEntityId);

    /**
     * Get an existing portlet entity for the entity id. If no entity exists for the id null will be
     * returned.
     *
     * @param portletEntityId The id of the entity to retrieve
     * @return The portlet entity for the id, null if no entity exists for the id.
     * @throws IllegalArgumentException If portletEntityId is null.
     */
    public IPortletEntity getPortletEntity(
            HttpServletRequest request, IPortletEntityId portletEntityId);

    /**
     * Get an existing portlet entity for the String version of the entity id. If an exception
     * occurs while parsing the String into an {@link IPortletEntityId} an {@link
     * IllegalArgumentException} will be thrown. If no entity exists for the id null will be
     * returned.
     *
     * @param portletEntityIdString The id of the entity to retrieve
     * @return The portlet entity for the id, null if no entity exists for the id.
     * @throws IllegalArgumentException If portletEntityIdString is null or cannot be parsed into a
     *     {@link IPortletEntityId}.
     */
    public IPortletEntity getPortletEntity(
            HttpServletRequest request, String portletEntityIdString);

    public IPortletEntity getOrCreateDefaultPortletEntity(
            HttpServletRequest request, IPortletDefinitionId portletDefinitionId);

    /**
     * Convenience for {@link #getPortletEntity(String, int)} and {@link
     * #createPortletEntity(IPortletDefinitionId, String, int)}. If the get returns null the entity
     * will be created and returned.
     *
     * @see #getPortletEntity(String, int)
     * @see #createPortletEntity(IPortletDefinitionId, String, int)
     */
    public IPortletEntity getOrCreatePortletEntity(
            HttpServletRequest request,
            IPortletDefinitionId portletDefinitionId,
            String layoutNodeId,
            int userId);

    /**
     * Convenience that looks up the portlet definition by subscribe ID then gets or creates the
     * portlet entity for the subscription
     */
    public IPortletEntity getOrCreatePortletEntity(
            HttpServletRequest request, IUserInstance userInstance, String layoutNodeId);

    /** Gets or creates a portlet entity for a specific fname. */
    public IPortletEntity getOrCreatePortletEntityByFname(
            HttpServletRequest request, IUserInstance userInstance, String fname);
    /**
     * Same as {@link #getOrCreatePortletEntityByFname(IUserInstance, String)} but also provides a
     * preferred channel subscribe id. If the specified subscribe ID can be found in the user's
     * layout it is used, if not the functionality provided by {@link
     * #getOrCreatePortletEntityByFname(IUserInstance, String)} is used.
     */
    public IPortletEntity getOrCreatePortletEntityByFname(
            HttpServletRequest request,
            IUserInstance userInstance,
            String fname,
            String preferredChannelSubscribeId);

    /**
     * Gets or Creates a delegate portlet entity based on the portlet definition and for delegation
     * to by the portlet window.
     *
     * @param request The current request
     * @param parentPortletWindowId The portlet window that is initiating the delegation
     * @param delegatePortletDefinitionId The portlet definition that will be delegated to
     * @return A delegate portlet entity
     */
    public IPortletEntity getOrCreateDelegatePortletEntity(
            HttpServletRequest request,
            IPortletWindowId parentPortletWindowId,
            IPortletDefinitionId delegatePortletDefinitionId);

    /**
     * Stores changes made to an existing portlet entity
     *
     * @param portletEntity The entity to update the persistent store for
     * @throws IllegalArgumentException if portletEntity is null
     */
    public void storePortletEntity(HttpServletRequest request, IPortletEntity portletEntity);

    /** @return True if the specified portlet entity should be persistent */
    public boolean shouldBePersisted(IPortletEntity portletEntity);
}