com.liferay.portal.util
Interface Portal

public interface Portal

View Source

Author:

Brian Wing Shun Chan

Field Summary

static java.lang.String	PATH_IMAGE
static java.lang.String	PATH_MAIN
static java.lang.String	PATH_PORTAL_LAYOUT
static java.lang.String	PORTLET_XML_FILE_NAME_CUSTOM
static java.lang.String	PORTLET_XML_FILE_NAME_STANDARD
static java.util.Date	UP_TIME

Method Summary

void	clearRequestParameters(javax.portlet.RenderRequest renderRequest)
void	copyRequestParameters(javax.portlet.ActionRequest actionRequest, javax.portlet.ActionResponse actionResponse)
java.lang.String	getCDNHost()
java.lang.String	getClassName(long classNameId)
long	getClassNameId(java.lang.Class<?> classObj)
long	getClassNameId(java.lang.String value)
java.lang.String	getClassNamePortletId(java.lang.String className)
java.lang.String	getCommunityLoginURL(ThemeDisplay themeDisplay)
Company	getCompany(javax.servlet.http.HttpServletRequest request)
Company	getCompany(javax.portlet.PortletRequest portletRequest)
long	getCompanyId(javax.servlet.http.HttpServletRequest requestuest)
long	getCompanyId(javax.portlet.PortletRequest portletRequest)
long[]	getCompanyIds()
java.lang.String	getComputerAddress()
java.lang.String	getComputerName()
java.lang.String	getControlPanelCategory(long companyId, java.lang.String portletId)
java.util.List<Portlet>	getControlPanelPortlets(long companyId, java.lang.String category)
java.lang.String	getCurrentURL(javax.servlet.http.HttpServletRequest request)
java.lang.String	getCurrentURL(javax.portlet.PortletRequest portletRequest)
java.lang.String	getCustomSQLFunctionIsNotNull()
java.lang.String	getCustomSQLFunctionIsNull()
java.util.Date	getDate(int month, int day, int year, int hour, int min, com.liferay.portal.PortalException pe)
java.util.Date	getDate(int month, int day, int year, int hour, int min, java.util.TimeZone timeZone, com.liferay.portal.PortalException pe)
java.util.Date	getDate(int month, int day, int year, com.liferay.portal.PortalException pe)
java.util.Date	getDate(int month, int day, int year, java.util.TimeZone timeZone, com.liferay.portal.PortalException pe)
long	getDefaultCompanyId()
java.util.Map<java.lang.String,java.io.Serializable>	getExpandoBridgeAttributes(ExpandoBridge expandoBridge, javax.portlet.PortletRequest portletRequest)
java.lang.String	getFirstPageLayoutTypes(javax.servlet.jsp.PageContext pageContext)
java.lang.String	getHomeURL(javax.servlet.http.HttpServletRequest request)
java.lang.String	getHost(javax.servlet.http.HttpServletRequest request)
java.lang.String	getHost(javax.portlet.PortletRequest portletRequest)
javax.servlet.http.HttpServletRequest	getHttpServletRequest(javax.portlet.PortletRequest portletRequest)
javax.servlet.http.HttpServletResponse	getHttpServletResponse(javax.portlet.PortletResponse portletResponse)
java.lang.String	getJsSafePortletId(java.lang.String portletId)
java.lang.String	getLayoutActualURL(Layout layout)
java.lang.String	getLayoutActualURL(Layout layout, java.lang.String mainPath)
java.lang.String	getLayoutActualURL(long groupId, boolean privateLayout, java.lang.String mainPath, java.lang.String friendlyURL)
java.lang.String	getLayoutActualURL(long groupId, boolean privateLayout, java.lang.String mainPath, java.lang.String friendlyURL, java.util.Map<java.lang.String,java.lang.String[]> params)
java.lang.String	getLayoutEditPage(Layout layout)
java.lang.String	getLayoutFriendlyURL(Layout layout, ThemeDisplay themeDisplay)
java.lang.String	getLayoutSetFriendlyURL(LayoutSet layoutSet, ThemeDisplay themeDisplay)
java.lang.String	getLayoutTarget(Layout layout)
java.lang.String	getLayoutURL(Layout layout, ThemeDisplay themeDisplay)
java.lang.String	getLayoutURL(Layout layout, ThemeDisplay themeDisplay, boolean doAsUser)
java.lang.String	getLayoutURL(ThemeDisplay themeDisplay)
java.lang.String	getLayoutViewPage(Layout layout)
java.util.Locale	getLocale(javax.servlet.http.HttpServletRequest request)
java.util.Locale	getLocale(javax.portlet.RenderRequest renderRequest)
javax.servlet.http.HttpServletRequest	getOriginalServletRequest(javax.servlet.http.HttpServletRequest request)
java.lang.String	getPathContext()
java.lang.String	getPathFriendlyURLPrivateGroup()
java.lang.String	getPathFriendlyURLPrivateUser()
java.lang.String	getPathFriendlyURLPublic()
java.lang.String	getPathImage()
java.lang.String	getPathMain()
long	getPlidFromFriendlyURL(long companyId, java.lang.String friendlyURL)
long	getPlidFromPortletId(long groupId, boolean privateLayout, java.lang.String portletId)
java.lang.String	getPortalLibDir()
int	getPortalPort()
java.util.Properties	getPortalProperties()
java.lang.String	getPortalURL(javax.servlet.http.HttpServletRequest request)
java.lang.String	getPortalURL(javax.servlet.http.HttpServletRequest request, boolean secure)
java.lang.String	getPortalURL(javax.portlet.PortletRequest portletRequest)
java.lang.String	getPortalURL(javax.portlet.PortletRequest portletRequest, boolean secure)
java.lang.String	getPortalURL(java.lang.String serverName, int serverPort, boolean secure)
java.lang.String	getPortalURL(ThemeDisplay themeDisplay)
java.lang.String	getPortalWebDir()
java.lang.Object[]	getPortletFriendlyURLMapper(long groupId, boolean privateLayout, java.lang.String url)
java.lang.Object[]	getPortletFriendlyURLMapper(long groupId, boolean privateLayout, java.lang.String url, java.util.Map<java.lang.String,java.lang.String[]> params)
long	getPortletGroupId(javax.portlet.ActionRequest actionRequest) Deprecated. Use getScopeGroupId.
long	getPortletGroupId(javax.servlet.http.HttpServletRequest request) Deprecated. Use getScopeGroupId.
long	getPortletGroupId(Layout layout) Deprecated. Use getScopeGroupId.
long	getPortletGroupId(long plid) Deprecated. Use getScopeGroupId.
long	getPortletGroupId(javax.portlet.RenderRequest renderRequest) Deprecated. Use getScopeGroupId.
java.lang.String	getPortletId(javax.servlet.http.HttpServletRequest request)
java.lang.String	getPortletId(javax.portlet.PortletRequest portletRequest)
java.lang.String	getPortletNamespace(java.lang.String portletId)
java.lang.String	getPortletTitle(Portlet portlet, long companyId, java.util.Locale locale)
java.lang.String	getPortletTitle(Portlet portlet, long companyId, java.lang.String languageId)
java.lang.String	getPortletTitle(Portlet portlet, javax.servlet.ServletContext servletContext, java.util.Locale locale)
java.lang.String	getPortletTitle(Portlet portlet, User user)
java.lang.String	getPortletTitle(java.lang.String portletId, long companyId, java.util.Locale locale)
java.lang.String	getPortletTitle(java.lang.String portletId, long companyId, java.lang.String languageId)
java.lang.String	getPortletTitle(java.lang.String portletId, User user)
java.lang.String	getPortletXmlFileName()
javax.portlet.PortletPreferences	getPreferences(javax.servlet.http.HttpServletRequest request)
javax.portlet.PreferencesValidator	getPreferencesValidator(Portlet portlet)
long	getScopeGroupId(javax.servlet.http.HttpServletRequest request)
long	getScopeGroupId(javax.servlet.http.HttpServletRequest request, java.lang.String portletId)
long	getScopeGroupId(Layout layout)
long	getScopeGroupId(Layout layout, java.lang.String portletId)
long	getScopeGroupId(long plid)
long	getScopeGroupId(javax.portlet.PortletRequest portletRequest)
User	getSelectedUser(javax.servlet.http.HttpServletRequest request)
User	getSelectedUser(javax.servlet.http.HttpServletRequest request, boolean checkPermission)
User	getSelectedUser(javax.portlet.PortletRequest portletRequest)
User	getSelectedUser(javax.portlet.PortletRequest portletRequest, boolean checkPermission)
java.lang.String	getStaticResourceURL(javax.servlet.http.HttpServletRequest request, java.lang.String uri)
java.lang.String	getStaticResourceURL(javax.servlet.http.HttpServletRequest request, java.lang.String uri, long timestamp)
java.lang.String	getStaticResourceURL(javax.servlet.http.HttpServletRequest request, java.lang.String uri, java.lang.String queryString)
java.lang.String	getStaticResourceURL(javax.servlet.http.HttpServletRequest request, java.lang.String uri, java.lang.String queryString, long timestamp)
java.lang.String	getStrutsAction(javax.servlet.http.HttpServletRequest request)
java.lang.String[]	getSystemCommunityRoles()
java.lang.String[]	getSystemGroups()
java.lang.String[]	getSystemOrganizationRoles()
java.lang.String[]	getSystemRoles()
java.lang.String[]	getTagsCategories(javax.portlet.PortletRequest portletRequest)
java.lang.String[]	getTagsEntries(javax.portlet.PortletRequest portletRequest)
com.liferay.portal.kernel.upload.UploadPortletRequest	getUploadPortletRequest(javax.portlet.ActionRequest actionRequest)
com.liferay.portal.kernel.upload.UploadServletRequest	getUploadServletRequest(javax.servlet.http.HttpServletRequest request)
java.util.Date	getUptime()
java.lang.String	getURLWithSessionId(java.lang.String url, java.lang.String sessionId)
User	getUser(javax.servlet.http.HttpServletRequest request)
User	getUser(javax.portlet.PortletRequest portletRequest)
long	getUserId(javax.servlet.http.HttpServletRequest request)
long	getUserId(javax.portlet.PortletRequest portletRequest)
java.lang.String	getUserName(long userId, java.lang.String defaultUserName)
java.lang.String	getUserName(long userId, java.lang.String defaultUserName, javax.servlet.http.HttpServletRequest request)
java.lang.String	getUserName(long userId, java.lang.String defaultUserName, java.lang.String userAttribute)
java.lang.String	getUserName(long userId, java.lang.String defaultUserName, java.lang.String userAttribute, javax.servlet.http.HttpServletRequest request)
java.lang.String	getUserPassword(javax.servlet.http.HttpServletRequest request)
java.lang.String	getUserPassword(javax.servlet.http.HttpSession session)
java.lang.String	getUserPassword(javax.portlet.PortletRequest portletRequest)
java.lang.String	getUserValue(long userId, java.lang.String param, java.lang.String defaultValue)
java.lang.String	getWidgetURL(Portlet portlet, ThemeDisplay themeDisplay)
boolean	isLayoutFirstPageable(java.lang.String type)
boolean	isLayoutFriendliable(Layout layout)
boolean	isLayoutParentable(Layout layout)
boolean	isLayoutParentable(java.lang.String type)
boolean	isLayoutSitemapable(Layout layout)
boolean	isMethodGet(javax.portlet.PortletRequest portletRequest)
boolean	isMethodPost(javax.portlet.PortletRequest portletRequest)
boolean	isReservedParameter(java.lang.String name)
boolean	isSystemGroup(java.lang.String groupName)
boolean	isSystemRole(java.lang.String roleName)
boolean	isUpdateAvailable()
void	renderPage(java.lang.StringBuilder sb, javax.servlet.ServletContext servletContext, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, java.lang.String path)
void	renderPortlet(java.lang.StringBuilder sb, javax.servlet.ServletContext servletContext, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, Portlet portlet, java.lang.String queryString)
void	renderPortlet(java.lang.StringBuilder sb, javax.servlet.ServletContext servletContext, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, Portlet portlet, java.lang.String queryString, java.lang.String columnId, java.lang.Integer columnPos, java.lang.Integer columnCount)
void	renderPortlet(java.lang.StringBuilder sb, javax.servlet.ServletContext servletContext, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response, Portlet portlet, java.lang.String queryString, java.lang.String columnId, java.lang.Integer columnPos, java.lang.Integer columnCount, java.lang.String path)
void	sendError(java.lang.Exception e, javax.portlet.ActionRequest actionRequest, javax.portlet.ActionResponse actionResponse)
void	sendError(java.lang.Exception e, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
void	sendError(int status, java.lang.Exception e, javax.portlet.ActionRequest actionRequest, javax.portlet.ActionResponse actionResponse)
void	sendError(int status, java.lang.Exception e, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
void	setPageSubtitle(java.lang.String subtitle, javax.servlet.http.HttpServletRequest request) Sets the subtitle for a page.
void	setPageTitle(java.lang.String title, javax.servlet.http.HttpServletRequest request) Sets the whole title for a page.
void	setPortalPort(javax.servlet.http.HttpServletRequest request) Sets the port obtained on the first request to the portal.
void	storePreferences(javax.portlet.PortletPreferences preferences)
java.lang.String	transformCustomSQL(java.lang.String sql)
javax.portlet.PortletMode	updatePortletMode(java.lang.String portletId, User user, Layout layout, javax.portlet.PortletMode portletMode, javax.servlet.http.HttpServletRequest request)
javax.portlet.WindowState	updateWindowState(java.lang.String portletId, User user, Layout layout, javax.portlet.WindowState windowState, javax.servlet.http.HttpServletRequest request)

Field Detail

PATH_IMAGE

static final java.lang.String PATH_IMAGE

See Also:

Constant Field Values

PATH_MAIN

static final java.lang.String PATH_MAIN

See Also:

Constant Field Values

PATH_PORTAL_LAYOUT

static final java.lang.String PATH_PORTAL_LAYOUT

See Also:

Constant Field Values

PORTLET_XML_FILE_NAME_STANDARD

static final java.lang.String PORTLET_XML_FILE_NAME_STANDARD

See Also:

Constant Field Values

PORTLET_XML_FILE_NAME_CUSTOM

static final java.lang.String PORTLET_XML_FILE_NAME_CUSTOM

See Also:

Constant Field Values

UP_TIME

static final java.util.Date UP_TIME

Method Detail

clearRequestParameters

void clearRequestParameters(javax.portlet.RenderRequest renderRequest)

copyRequestParameters

void copyRequestParameters(javax.portlet.ActionRequest actionRequest,
                           javax.portlet.ActionResponse actionResponse)

getCDNHost

java.lang.String getCDNHost()

getClassName

java.lang.String getClassName(long classNameId)

getClassNameId

long getClassNameId(java.lang.Class<?> classObj)

getClassNameId

long getClassNameId(java.lang.String value)

getClassNamePortletId

java.lang.String getClassNamePortletId(java.lang.String className)

getCommunityLoginURL

java.lang.String getCommunityLoginURL(ThemeDisplay themeDisplay)
                                      throws com.liferay.portal.PortalException,
                                             com.liferay.portal.SystemException

Throws:

com.liferay.portal.PortalException

com.liferay.portal.SystemException

getCompany

Company getCompany(javax.servlet.http.HttpServletRequest request)
                   throws com.liferay.portal.PortalException,
                          com.liferay.portal.SystemException

Throws:

com.liferay.portal.PortalException

com.liferay.portal.SystemException

getCompany

Company getCompany(javax.portlet.PortletRequest portletRequest)
                   throws com.liferay.portal.PortalException,
                          com.liferay.portal.SystemException

Throws:

com.liferay.portal.PortalException

com.liferay.portal.SystemException

getCompanyId

long getCompanyId(javax.servlet.http.HttpServletRequest requestuest)

getCompanyId

long getCompanyId(javax.portlet.PortletRequest portletRequest)

getCompanyIds

long[] getCompanyIds()

getComputerAddress

java.lang.String getComputerAddress()

getComputerName

java.lang.String getComputerName()

getControlPanelCategory

java.lang.String getControlPanelCategory(long companyId,
                                         java.lang.String portletId)
                                         throws com.liferay.portal.SystemException

Throws:

com.liferay.portal.SystemException

getControlPanelPortlets

java.util.List<Portlet> getControlPanelPortlets(long companyId,
                                                java.lang.String category)
                                                throws com.liferay.portal.SystemException

Throws:

com.liferay.portal.SystemException

getCurrentURL

java.lang.String getCurrentURL(javax.servlet.http.HttpServletRequest request)

getCurrentURL

java.lang.String getCurrentURL(javax.portlet.PortletRequest portletRequest)

getCustomSQLFunctionIsNotNull

java.lang.String getCustomSQLFunctionIsNotNull()

getCustomSQLFunctionIsNull

java.lang.String getCustomSQLFunctionIsNull()

getDate

java.util.Date getDate(int month,
                       int day,
                       int year,
                       com.liferay.portal.PortalException pe)
                       throws com.liferay.portal.PortalException

Throws:

com.liferay.portal.PortalException

getDate

java.util.Date getDate(int month,
                       int day,
                       int year,
                       java.util.TimeZone timeZone,
                       com.liferay.portal.PortalException pe)
                       throws com.liferay.portal.PortalException

Throws:

com.liferay.portal.PortalException

getDate

java.util.Date getDate(int month,
                       int day,
                       int year,
                       int hour,
                       int min,
                       com.liferay.portal.PortalException pe)
                       throws com.liferay.portal.PortalException

Throws:

com.liferay.portal.PortalException

getDate

java.util.Date getDate(int month,
                       int day,
                       int year,
                       int hour,
                       int min,
                       java.util.TimeZone timeZone,
                       com.liferay.portal.PortalException pe)
                       throws com.liferay.portal.PortalException

Throws:

com.liferay.portal.PortalException

getDefaultCompanyId

long getDefaultCompanyId()

getExpandoBridgeAttributes

java.util.Map<java.lang.String,java.io.Serializable> getExpandoBridgeAttributes(ExpandoBridge expandoBridge,
                                                                                javax.portlet.PortletRequest portletRequest)
                                                                                throws com.liferay.portal.PortalException,
                                                                                       com.liferay.portal.SystemException

Throws:

com.liferay.portal.PortalException

com.liferay.portal.SystemException

getFirstPageLayoutTypes

java.lang.String getFirstPageLayoutTypes(javax.servlet.jsp.PageContext pageContext)

getHomeURL

java.lang.String getHomeURL(javax.servlet.http.HttpServletRequest request)
                            throws com.liferay.portal.PortalException,
                                   com.liferay.portal.SystemException

Throws:

com.liferay.portal.PortalException

com.liferay.portal.SystemException

getHost

java.lang.String getHost(javax.servlet.http.HttpServletRequest request)

getHost

java.lang.String getHost(javax.portlet.PortletRequest portletRequest)

getHttpServletRequest

javax.servlet.http.HttpServletRequest getHttpServletRequest(javax.portlet.PortletRequest portletRequest)

getHttpServletResponse

javax.servlet.http.HttpServletResponse getHttpServletResponse(javax.portlet.PortletResponse portletResponse)

getLayoutEditPage

java.lang.String getLayoutEditPage(Layout layout)

getLayoutViewPage

java.lang.String getLayoutViewPage(Layout layout)

getLayoutURL

java.lang.String getLayoutURL(ThemeDisplay themeDisplay)

getLayoutURL

java.lang.String getLayoutURL(Layout layout,
                              ThemeDisplay themeDisplay)

getLayoutURL

java.lang.String getLayoutURL(Layout layout,
                              ThemeDisplay themeDisplay,
                              boolean doAsUser)

getLayoutActualURL

java.lang.String getLayoutActualURL(Layout layout)

getLayoutActualURL

java.lang.String getLayoutActualURL(Layout layout,
                                    java.lang.String mainPath)

getLayoutActualURL

java.lang.String getLayoutActualURL(long groupId,
                                    boolean privateLayout,
                                    java.lang.String mainPath,
                                    java.lang.String friendlyURL)
                                    throws com.liferay.portal.PortalException,
                                           com.liferay.portal.SystemException

Throws:

com.liferay.portal.PortalException

com.liferay.portal.SystemException

getLayoutActualURL

java.lang.String getLayoutActualURL(long groupId,
                                    boolean privateLayout,
                                    java.lang.String mainPath,
                                    java.lang.String friendlyURL,
                                    java.util.Map<java.lang.String,java.lang.String[]> params)
                                    throws com.liferay.portal.PortalException,
                                           com.liferay.portal.SystemException

Throws:

com.liferay.portal.PortalException

com.liferay.portal.SystemException

getLayoutFriendlyURL

java.lang.String getLayoutFriendlyURL(Layout layout,
                                      ThemeDisplay themeDisplay)

getLayoutSetFriendlyURL

java.lang.String getLayoutSetFriendlyURL(LayoutSet layoutSet,
                                         ThemeDisplay themeDisplay)
                                         throws com.liferay.portal.PortalException,
                                                com.liferay.portal.SystemException

Throws:

com.liferay.portal.PortalException

com.liferay.portal.SystemException

getLayoutTarget

java.lang.String getLayoutTarget(Layout layout)

getJsSafePortletId

java.lang.String getJsSafePortletId(java.lang.String portletId)

getLocale

java.util.Locale getLocale(javax.servlet.http.HttpServletRequest request)

getLocale

java.util.Locale getLocale(javax.portlet.RenderRequest renderRequest)

getOriginalServletRequest

javax.servlet.http.HttpServletRequest getOriginalServletRequest(javax.servlet.http.HttpServletRequest request)

getPathContext

java.lang.String getPathContext()

getPathFriendlyURLPrivateGroup

java.lang.String getPathFriendlyURLPrivateGroup()

getPathFriendlyURLPrivateUser

java.lang.String getPathFriendlyURLPrivateUser()

getPathFriendlyURLPublic

java.lang.String getPathFriendlyURLPublic()

getPathImage

java.lang.String getPathImage()

getPathMain

java.lang.String getPathMain()

getPlidFromFriendlyURL

long getPlidFromFriendlyURL(long companyId,
                            java.lang.String friendlyURL)

getPlidFromPortletId

long getPlidFromPortletId(long groupId,
                          boolean privateLayout,
                          java.lang.String portletId)

getPortalLibDir

java.lang.String getPortalLibDir()

getPortalPort

int getPortalPort()

getPortalProperties

java.util.Properties getPortalProperties()

getPortalURL

java.lang.String getPortalURL(ThemeDisplay themeDisplay)

getPortalURL

java.lang.String getPortalURL(javax.servlet.http.HttpServletRequest request)

getPortalURL

java.lang.String getPortalURL(javax.servlet.http.HttpServletRequest request,
                              boolean secure)

getPortalURL

java.lang.String getPortalURL(javax.portlet.PortletRequest portletRequest)

getPortalURL

java.lang.String getPortalURL(javax.portlet.PortletRequest portletRequest,
                              boolean secure)

getPortalURL

java.lang.String getPortalURL(java.lang.String serverName,
                              int serverPort,
                              boolean secure)

getPortalWebDir

java.lang.String getPortalWebDir()

getPortletFriendlyURLMapper

java.lang.Object[] getPortletFriendlyURLMapper(long groupId,
                                               boolean privateLayout,
                                               java.lang.String url)
                                               throws com.liferay.portal.PortalException,
                                                      com.liferay.portal.SystemException

Throws:

com.liferay.portal.PortalException

com.liferay.portal.SystemException

getPortletFriendlyURLMapper

java.lang.Object[] getPortletFriendlyURLMapper(long groupId,
                                               boolean privateLayout,
                                               java.lang.String url,
                                               java.util.Map<java.lang.String,java.lang.String[]> params)
                                               throws com.liferay.portal.PortalException,
                                                      com.liferay.portal.SystemException

Throws:

com.liferay.portal.PortalException

com.liferay.portal.SystemException

getPortletGroupId

long getPortletGroupId(long plid)

Deprecated. Use getScopeGroupId.

getPortletGroupId

long getPortletGroupId(Layout layout)

Deprecated. Use getScopeGroupId.

getPortletGroupId

long getPortletGroupId(javax.servlet.http.HttpServletRequest request)

Deprecated. Use getScopeGroupId.

getPortletGroupId

long getPortletGroupId(javax.portlet.ActionRequest actionRequest)

Deprecated. Use getScopeGroupId.

getPortletGroupId

long getPortletGroupId(javax.portlet.RenderRequest renderRequest)

Deprecated. Use getScopeGroupId.

getPortletId

java.lang.String getPortletId(javax.servlet.http.HttpServletRequest request)

getPortletId

java.lang.String getPortletId(javax.portlet.PortletRequest portletRequest)

getPortletNamespace

java.lang.String getPortletNamespace(java.lang.String portletId)

getPortletTitle

java.lang.String getPortletTitle(java.lang.String portletId,
                                 long companyId,
                                 java.lang.String languageId)

getPortletTitle

java.lang.String getPortletTitle(java.lang.String portletId,
                                 long companyId,
                                 java.util.Locale locale)

getPortletTitle

java.lang.String getPortletTitle(java.lang.String portletId,
                                 User user)

getPortletTitle

java.lang.String getPortletTitle(Portlet portlet,
                                 long companyId,
                                 java.lang.String languageId)

getPortletTitle

java.lang.String getPortletTitle(Portlet portlet,
                                 long companyId,
                                 java.util.Locale locale)

getPortletTitle

java.lang.String getPortletTitle(Portlet portlet,
                                 User user)

getPortletTitle

java.lang.String getPortletTitle(Portlet portlet,
                                 javax.servlet.ServletContext servletContext,
                                 java.util.Locale locale)

getPortletXmlFileName

java.lang.String getPortletXmlFileName()
                                       throws com.liferay.portal.SystemException

Throws:

com.liferay.portal.SystemException

getPreferences

javax.portlet.PortletPreferences getPreferences(javax.servlet.http.HttpServletRequest request)

getPreferencesValidator

javax.portlet.PreferencesValidator getPreferencesValidator(Portlet portlet)

getScopeGroupId

long getScopeGroupId(long plid)

getScopeGroupId

long getScopeGroupId(Layout layout)

getScopeGroupId

long getScopeGroupId(Layout layout,
                     java.lang.String portletId)

getScopeGroupId

long getScopeGroupId(javax.servlet.http.HttpServletRequest request)

getScopeGroupId

long getScopeGroupId(javax.servlet.http.HttpServletRequest request,
                     java.lang.String portletId)

getScopeGroupId

long getScopeGroupId(javax.portlet.PortletRequest portletRequest)

getSelectedUser

User getSelectedUser(javax.servlet.http.HttpServletRequest request)
                     throws com.liferay.portal.PortalException,
                            com.liferay.portal.SystemException

Throws:

com.liferay.portal.PortalException

com.liferay.portal.SystemException

getSelectedUser

User getSelectedUser(javax.servlet.http.HttpServletRequest request,
                     boolean checkPermission)
                     throws com.liferay.portal.PortalException,
                            com.liferay.portal.SystemException

Throws:

com.liferay.portal.PortalException

com.liferay.portal.SystemException

getSelectedUser

User getSelectedUser(javax.portlet.PortletRequest portletRequest)
                     throws com.liferay.portal.PortalException,
                            com.liferay.portal.SystemException

Throws:

com.liferay.portal.PortalException

com.liferay.portal.SystemException

getSelectedUser

User getSelectedUser(javax.portlet.PortletRequest portletRequest,
                     boolean checkPermission)
                     throws com.liferay.portal.PortalException,
                            com.liferay.portal.SystemException

Throws:

com.liferay.portal.PortalException

com.liferay.portal.SystemException

getStaticResourceURL

java.lang.String getStaticResourceURL(javax.servlet.http.HttpServletRequest request,
                                      java.lang.String uri)

getStaticResourceURL

java.lang.String getStaticResourceURL(javax.servlet.http.HttpServletRequest request,
                                      java.lang.String uri,
                                      java.lang.String queryString)

getStaticResourceURL

java.lang.String getStaticResourceURL(javax.servlet.http.HttpServletRequest request,
                                      java.lang.String uri,
                                      long timestamp)

getStaticResourceURL

java.lang.String getStaticResourceURL(javax.servlet.http.HttpServletRequest request,
                                      java.lang.String uri,
                                      java.lang.String queryString,
                                      long timestamp)

getStrutsAction

java.lang.String getStrutsAction(javax.servlet.http.HttpServletRequest request)

getSystemCommunityRoles

java.lang.String[] getSystemCommunityRoles()

getSystemGroups

java.lang.String[] getSystemGroups()

getSystemOrganizationRoles

java.lang.String[] getSystemOrganizationRoles()

getSystemRoles

java.lang.String[] getSystemRoles()

getTagsCategories

java.lang.String[] getTagsCategories(javax.portlet.PortletRequest portletRequest)

getTagsEntries

java.lang.String[] getTagsEntries(javax.portlet.PortletRequest portletRequest)

getUploadPortletRequest

com.liferay.portal.kernel.upload.UploadPortletRequest getUploadPortletRequest(javax.portlet.ActionRequest actionRequest)

getUploadServletRequest

com.liferay.portal.kernel.upload.UploadServletRequest getUploadServletRequest(javax.servlet.http.HttpServletRequest request)

getUptime

java.util.Date getUptime()

getURLWithSessionId

java.lang.String getURLWithSessionId(java.lang.String url,
                                     java.lang.String sessionId)

getUser

User getUser(javax.servlet.http.HttpServletRequest request)
             throws com.liferay.portal.PortalException,
                    com.liferay.portal.SystemException

Throws:

com.liferay.portal.PortalException

com.liferay.portal.SystemException

getUser

User getUser(javax.portlet.PortletRequest portletRequest)
             throws com.liferay.portal.PortalException,
                    com.liferay.portal.SystemException

Throws:

com.liferay.portal.PortalException

com.liferay.portal.SystemException

getUserId

long getUserId(javax.servlet.http.HttpServletRequest request)

getUserId

long getUserId(javax.portlet.PortletRequest portletRequest)

getUserName

java.lang.String getUserName(long userId,
                             java.lang.String defaultUserName)

getUserName

java.lang.String getUserName(long userId,
                             java.lang.String defaultUserName,
                             java.lang.String userAttribute)

getUserName

java.lang.String getUserName(long userId,
                             java.lang.String defaultUserName,
                             javax.servlet.http.HttpServletRequest request)

getUserName

java.lang.String getUserName(long userId,
                             java.lang.String defaultUserName,
                             java.lang.String userAttribute,
                             javax.servlet.http.HttpServletRequest request)

getUserPassword

java.lang.String getUserPassword(javax.servlet.http.HttpSession session)

getUserPassword

java.lang.String getUserPassword(javax.servlet.http.HttpServletRequest request)

getUserPassword

java.lang.String getUserPassword(javax.portlet.PortletRequest portletRequest)

getUserValue

java.lang.String getUserValue(long userId,
                              java.lang.String param,
                              java.lang.String defaultValue)
                              throws com.liferay.portal.SystemException

Throws:

com.liferay.portal.SystemException

getWidgetURL

java.lang.String getWidgetURL(Portlet portlet,
                              ThemeDisplay themeDisplay)

isLayoutFirstPageable

boolean isLayoutFirstPageable(java.lang.String type)

isLayoutFriendliable

boolean isLayoutFriendliable(Layout layout)

isLayoutParentable

boolean isLayoutParentable(Layout layout)

isLayoutParentable

boolean isLayoutParentable(java.lang.String type)

isLayoutSitemapable

boolean isLayoutSitemapable(Layout layout)

isMethodGet

boolean isMethodGet(javax.portlet.PortletRequest portletRequest)

isMethodPost

boolean isMethodPost(javax.portlet.PortletRequest portletRequest)

isReservedParameter

boolean isReservedParameter(java.lang.String name)

isSystemGroup

boolean isSystemGroup(java.lang.String groupName)

isSystemRole

boolean isSystemRole(java.lang.String roleName)

isUpdateAvailable

boolean isUpdateAvailable()
                          throws com.liferay.portal.PortalException,
                                 com.liferay.portal.SystemException

Throws:

com.liferay.portal.PortalException

com.liferay.portal.SystemException

renderPage

void renderPage(java.lang.StringBuilder sb,
                javax.servlet.ServletContext servletContext,
                javax.servlet.http.HttpServletRequest request,
                javax.servlet.http.HttpServletResponse response,
                java.lang.String path)
                throws java.io.IOException,
                       javax.servlet.ServletException

Throws:

java.io.IOException

javax.servlet.ServletException

renderPortlet

void renderPortlet(java.lang.StringBuilder sb,
                   javax.servlet.ServletContext servletContext,
                   javax.servlet.http.HttpServletRequest request,
                   javax.servlet.http.HttpServletResponse response,
                   Portlet portlet,
                   java.lang.String queryString)
                   throws java.io.IOException,
                          javax.servlet.ServletException

Throws:

java.io.IOException

javax.servlet.ServletException

renderPortlet

void renderPortlet(java.lang.StringBuilder sb,
                   javax.servlet.ServletContext servletContext,
                   javax.servlet.http.HttpServletRequest request,
                   javax.servlet.http.HttpServletResponse response,
                   Portlet portlet,
                   java.lang.String queryString,
                   java.lang.String columnId,
                   java.lang.Integer columnPos,
                   java.lang.Integer columnCount)
                   throws java.io.IOException,
                          javax.servlet.ServletException

Throws:

java.io.IOException

javax.servlet.ServletException

renderPortlet

void renderPortlet(java.lang.StringBuilder sb,
                   javax.servlet.ServletContext servletContext,
                   javax.servlet.http.HttpServletRequest request,
                   javax.servlet.http.HttpServletResponse response,
                   Portlet portlet,
                   java.lang.String queryString,
                   java.lang.String columnId,
                   java.lang.Integer columnPos,
                   java.lang.Integer columnCount,
                   java.lang.String path)
                   throws java.io.IOException,
                          javax.servlet.ServletException

Throws:

java.io.IOException

javax.servlet.ServletException

sendError

void sendError(java.lang.Exception e,
               javax.servlet.http.HttpServletRequest request,
               javax.servlet.http.HttpServletResponse response)
               throws java.io.IOException,
                      javax.servlet.ServletException

Throws:

java.io.IOException

javax.servlet.ServletException

sendError

void sendError(int status,
               java.lang.Exception e,
               javax.servlet.http.HttpServletRequest request,
               javax.servlet.http.HttpServletResponse response)
               throws java.io.IOException,
                      javax.servlet.ServletException

Throws:

java.io.IOException

javax.servlet.ServletException

sendError

void sendError(java.lang.Exception e,
               javax.portlet.ActionRequest actionRequest,
               javax.portlet.ActionResponse actionResponse)
               throws java.io.IOException

Throws:

java.io.IOException

sendError

void sendError(int status,
               java.lang.Exception e,
               javax.portlet.ActionRequest actionRequest,
               javax.portlet.ActionResponse actionResponse)
               throws java.io.IOException

Throws:

java.io.IOException

setPageSubtitle

void setPageSubtitle(java.lang.String subtitle,
                     javax.servlet.http.HttpServletRequest request)

Sets the subtitle for a page. This is just a hint and can be overridden by subsequent calls. The last call to this method wins.

Parameters:

subtitle - the subtitle for a page

req - the HTTP servlet request

setPageTitle

void setPageTitle(java.lang.String title,
                  javax.servlet.http.HttpServletRequest request)

Sets the whole title for a page. This is just a hint and can be overridden by subsequent calls. The last call to this method wins.

Parameters:

title - the whole title for a page

req - the HTTP servlet request

setPortalPort

void setPortalPort(javax.servlet.http.HttpServletRequest request)

Sets the port obtained on the first request to the portal.

Parameters:

req - the HTTP servlet request

storePreferences

void storePreferences(javax.portlet.PortletPreferences preferences)
                      throws java.io.IOException,
                             javax.portlet.ValidatorException

Throws:

java.io.IOException

javax.portlet.ValidatorException

transformCustomSQL

java.lang.String transformCustomSQL(java.lang.String sql)

updatePortletMode

javax.portlet.PortletMode updatePortletMode(java.lang.String portletId,
                                            User user,
                                            Layout layout,
                                            javax.portlet.PortletMode portletMode,
                                            javax.servlet.http.HttpServletRequest request)

updateWindowState

javax.portlet.WindowState updateWindowState(java.lang.String portletId,
                                            User user,
                                            Layout layout,
                                            javax.portlet.WindowState windowState,
                                            javax.servlet.http.HttpServletRequest request)