com.liferay.faces.portal.context.LiferayPortletHelper Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of com.liferay.faces.portal Show documentation
The newest version!
/**
 * Copyright (c) 2000-2022 Liferay, Inc. All rights reserved.
 *
 * This library is free software; you can redistribute it and/or modify it under
 * the terms of the GNU Lesser General Public License as published by the Free
 * Software Foundation; either version 2.1 of the License, or (at your option)
 * any later version.
 *
 * This library is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
 * details.
 */
package com.liferay.faces.portal.context;

import java.util.List;

import com.liferay.faces.portal.security.AuthorizationException;

import com.liferay.portal.kernel.exception.SystemException;
import com.liferay.portal.kernel.model.Group;
import com.liferay.portal.kernel.model.Layout;
import com.liferay.portal.kernel.model.Portlet;
import com.liferay.portal.kernel.model.Role;
import com.liferay.portal.kernel.model.Theme;
import com.liferay.portal.kernel.model.User;
import com.liferay.portal.kernel.security.permission.PermissionChecker;
import com.liferay.portal.kernel.service.ServiceContext;
import com.liferay.portal.kernel.theme.ThemeDisplay;


/**
 * This interface defines a set of convenience methods for Liferay portlet development.
 *
 * @author  Neil Griffin
 */
public interface LiferayPortletHelper {

	/**
	 * Checks to see if the current user has permission to execute the specified actionId (which, in turn, is assumed to
	 * be an action defined for the current portlet). If the authorization fails, a PrincipalException is thrown. Any
	 * other errors that occur will be caught and re-thrown, wrapped in a PortletRuntimeException.
	 *
	 * @throws  AuthorizationException  If the user does not have the portlet permission associated with the specified
	 *                                  actionId.
	 *
	 * @see     #userHasPortletPermission(String)
	 */
	public void checkUserPortletPermission(String actionId) throws AuthorizationException;

	/**
	 * Returns the build identifier for the running version of Liferay Portal.
	 */
	public int getBuildNumber();

	/**
	 * Returns the company Id associated with the community that is hosting the portlet associated with the current JSF
	 * FacesContext.
	 */
	public long getCompanyId();

	/**
	 * Returns an absolute URL to the Liferay document library, which is the main part of different struts action paths.
	 */
	public String getDocumentLibraryURL();

	/**
	 * Returns the "group Id" associated with the community that is hosting the portlet associated with the current JSF
	 * FacesContext.
	 */
	public long getHostGroupId();

	/**
	 * Returns an absolute URL to the Liferay image gallery, which is the main part of different struts action paths.
	 */
	public String getImageGalleryURL();

	/**
	 * Returns the layout being displayed in the current context.
	 */
	public Layout getLayout();

	/**
	 * Returns the Liferay PermissionChecker associated with the request.
	 */
	public PermissionChecker getPermissionChecker();

	/**
	 * Returns the "Plid" (the "portal layout id"), which is the identifier of the specific "page" the portlet exists
	 * on. Plid is the primary key of the "Layout" table.
	 */
	public long getPlid();

	/**
	 * Returns an absolute URL which is the context-path of the portal webapp.
	 */
	public String getPortalURL();

	/**
	 * Returns the com.liferay.portal.model.Portlet object for the portlet associated with the current
	 * request.
	 */
	public Portlet getPortlet();

	/**
	 * Returns the "portlet instance Id" of the currently running portlet. This id is an internal identifier used by the
	 * Liferay API. Note that the Liferay API for getPorletId() is not exposed as getPortletId() in this API -- instead
	 * it is exposed as getPortletInstanceId(). This is because the Liferay API getPortletId() actually returns the
	 * "instance id" of the portlet, whereas most of the time developers really want the "root id" instead.
	 *
	 * @see  PortletHelper#getPortletName()
	 */
	public String getPortletInstanceId();

	/**
	 * Returns the "portlet root Id" of the currently running portlet. This id is an internal identifier used by the
	 * Liferay API. Note that the Liferay API for getPorletId() is not exposed as getPortletId() in this API -- instead
	 * it is exposed as getPortletInstanceId(). This is because the Liferay API getPortletId() actually returns the
	 * "instance id" of the portlet, whereas most of the time developers really want the "root id" instead.
	 *
	 * @see  PortletHelper#getPortletName()
	 */
	public String getPortletRootId();

	/**
	 * Returns the group (Liferay community) associated with the layout (portal page) that the portlet resides on.
	 */
	public Group getScopeGroup();

	/**
	 * Returns the unique id of the group (Liferay community) associated with the layout (portal page) that the portlet
	 * resides on.
	 */
	public long getScopeGroupId();

	/**
	 * Returns the user associated with the group (Liferay community) associated with the layout (portal page) that the
	 * portlet resides on.
	 */
	public User getScopeGroupUser();

	/**
	 * Returns an instance of a ServiceContext associated with the specified className.
	 */
	public ServiceContext getServiceContext();

	/**
	 * Returns the theme being displayed in the current context.
	 */
	public Theme getTheme();

	/**
	 * Returns the com.liferay.portal.kernel.theme.ThemeDisplay object, which contains a variety methods
	 * for rendering theme specific look and feels.
	 */
	public ThemeDisplay getThemeDisplay();

	/**
	 * Returns an absolute URL which is the path to the images of the theme associated with the current Layout.
	 */
	public String getThemeImagesURL();

	/**
	 * Returns the user record of the user associated with the current JSF FacesContext.
	 */
	public User getUser();

	/**
	 * Returns the user Id of the user associated with the current JSF FacesContext
	 */
	public long getUserId();

	/**
	 * Returns a list of all of the roles played by the user associated with the current JSF FacesContext.
	 */
	public List getUserRoles() throws SystemException;

	/**
	 * Returns true if the current user has permission to execute the specified actionId (which, in turn,
	 * is assumed to be an action defined for the current portlet). Any errors that occur will be caught and re-thrown,
	 * wrapped in a PortletRuntimeException.
	 *
	 * @see  #checkUserPortletPermission(String)
	 */
	public boolean userHasPortletPermission(String actionId);

	/**
	 * Returns true if the current user has the specified role name.
	 */
	public boolean userHasRole(String roleName);
}