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 req)
           
 void copyRequestParameters(javax.portlet.ActionRequest req, javax.portlet.ActionResponse res)
           
 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)
           
 Company getCompany(javax.portlet.ActionRequest req)
           
 Company getCompany(javax.servlet.http.HttpServletRequest req)
           
 Company getCompany(javax.portlet.RenderRequest req)
           
 long getCompanyId(javax.portlet.ActionRequest req)
           
 long getCompanyId(javax.servlet.http.HttpServletRequest req)
           
 long getCompanyId(javax.portlet.PortletRequest req)
           
 long getCompanyId(javax.portlet.RenderRequest req)
           
 long getCompanyIdByWebId(javax.servlet.ServletContext ctx)
           
 long getCompanyIdByWebId(java.lang.String webId)
           
 java.lang.String getComputerName()
           
 java.lang.String getCurrentURL(javax.servlet.http.HttpServletRequest req)
           
 java.lang.String getCurrentURL(javax.portlet.PortletRequest req)
           
 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)
           
 java.lang.String getHost(javax.portlet.ActionRequest req)
           
 java.lang.String getHost(javax.servlet.http.HttpServletRequest req)
           
 java.lang.String getHost(javax.portlet.RenderRequest req)
           
 javax.servlet.http.HttpServletRequest getHttpServletRequest(javax.portlet.PortletRequest req)
           
 javax.servlet.http.HttpServletResponse getHttpServletResponse(javax.portlet.PortletResponse res)
           
 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 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 req)
           
 java.util.Locale getLocale(javax.portlet.RenderRequest req)
           
 javax.servlet.http.HttpServletRequest getOriginalServletRequest(javax.servlet.http.HttpServletRequest req)
           
 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 getPlidIdFromFriendlyURL(long companyId, java.lang.String friendlyURL)
           
 java.lang.String getPortalLibDir()
           
 java.lang.String getPortalURL(javax.servlet.http.HttpServletRequest req)
           
 java.lang.String getPortalURL(javax.servlet.http.HttpServletRequest req, boolean secure)
           
 java.lang.String getPortalURL(javax.portlet.PortletRequest req)
           
 java.lang.String getPortalURL(javax.portlet.PortletRequest req, boolean secure)
           
 java.lang.String getPortalURL(java.lang.String serverName, int serverPort, boolean secure)
           
 java.lang.String getPortalURL(ThemeDisplay themeDisplay)
           
 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 req)
           
 long getPortletGroupId(javax.servlet.http.HttpServletRequest req)
           
 long getPortletGroupId(Layout layout)
           
 long getPortletGroupId(long plid)
           
 long getPortletGroupId(javax.portlet.RenderRequest req)
           
 java.lang.String getPortletNamespace(java.lang.String portletId)
           
 java.lang.String getPortletTitle(Portlet portlet, javax.servlet.ServletContext ctx, java.util.Locale locale)
           
 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 req)
           
 javax.portlet.PreferencesValidator getPreferencesValidator(Portlet portlet)
           
 User getSelectedUser(javax.portlet.ActionRequest req)
           
 User getSelectedUser(javax.portlet.ActionRequest req, boolean checkPermission)
           
 User getSelectedUser(javax.servlet.http.HttpServletRequest req)
           
 User getSelectedUser(javax.servlet.http.HttpServletRequest req, boolean checkPermission)
           
 User getSelectedUser(javax.portlet.RenderRequest req)
           
 User getSelectedUser(javax.portlet.RenderRequest req, boolean checkPermission)
           
 java.lang.String getStrutsAction(javax.servlet.http.HttpServletRequest req)
           
 java.lang.String[] getSystemCommunityRoles()
           
 java.lang.String[] getSystemGroups()
           
 java.lang.String[] getSystemOrganizationRoles()
           
 java.lang.String[] getSystemRoles()
           
 java.util.Date getUptime()
           
 java.lang.String getURLWithSessionId(java.lang.String url, java.lang.String sessionId)
           
 User getUser(javax.portlet.ActionRequest req)
           
 User getUser(javax.servlet.http.HttpServletRequest req)
           
 User getUser(javax.portlet.RenderRequest req)
           
 long getUserId(javax.portlet.ActionRequest req)
           
 long getUserId(javax.servlet.http.HttpServletRequest req)
           
 long getUserId(javax.portlet.RenderRequest req)
           
 java.lang.String getUserName(long userId, java.lang.String defaultUserName)
           
 java.lang.String getUserName(long userId, java.lang.String defaultUserName, javax.servlet.http.HttpServletRequest req)
           
 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 req)
           
 java.lang.String getUserPassword(javax.portlet.ActionRequest req)
           
 java.lang.String getUserPassword(javax.servlet.http.HttpServletRequest req)
           
 java.lang.String getUserPassword(javax.servlet.http.HttpSession ses)
           
 java.lang.String getUserPassword(javax.portlet.RenderRequest req)
           
 java.lang.String getUserValue(long userId, java.lang.String param, java.lang.String defaultValue)
           
 boolean isLayoutFriendliable(Layout layout)
           
 boolean isLayoutParentable(Layout layout)
           
 boolean isLayoutParentable(java.lang.String type)
           
 boolean isLayoutSitemapable(Layout layout)
           
 boolean isMethodGet(javax.portlet.PortletRequest req)
           
 boolean isMethodPost(javax.portlet.PortletRequest req)
           
 boolean isReservedParameter(java.lang.String name)
           
 boolean isSystemGroup(java.lang.String groupName)
           
 boolean isSystemRole(java.lang.String roleName)
           
 boolean isUpdateAvailable()
           
 void renderPage(com.liferay.portal.kernel.util.StringMaker sm, javax.servlet.ServletContext ctx, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res, java.lang.String path)
           
 void renderPortlet(com.liferay.portal.kernel.util.StringMaker sm, javax.servlet.ServletContext ctx, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res, Portlet portlet, java.lang.String queryString)
           
 void renderPortlet(com.liferay.portal.kernel.util.StringMaker sm, javax.servlet.ServletContext ctx, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res, Portlet portlet, java.lang.String queryString, java.lang.String columnId, java.lang.Integer columnPos, java.lang.Integer columnCount)
           
 void renderPortlet(com.liferay.portal.kernel.util.StringMaker sm, javax.servlet.ServletContext ctx, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res, Portlet portlet, java.lang.String queryString, java.lang.String columnId, java.lang.Integer columnPos, java.lang.Integer columnCount, java.lang.String path)
           
 void sendError(int status, java.lang.Exception e, javax.servlet.http.HttpServletRequest req, javax.servlet.http.HttpServletResponse res)
           
 void setPageSubtitle(java.lang.String subtitle, javax.servlet.http.HttpServletRequest req)
          Sets the subtitle for a page.
 void setPageTitle(java.lang.String title, javax.servlet.http.HttpServletRequest req)
          Sets the whole title for a page.
 void storePreferences(javax.portlet.PortletPreferences prefs)
           
 javax.portlet.PortletMode updatePortletMode(java.lang.String portletId, User user, Layout layout, javax.portlet.PortletMode portletMode, javax.servlet.http.HttpServletRequest req)
           
 javax.portlet.WindowState updateWindowState(java.lang.String portletId, User user, Layout layout, javax.portlet.WindowState windowState, javax.servlet.http.HttpServletRequest req)
           
 

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 req)

copyRequestParameters

void copyRequestParameters(javax.portlet.ActionRequest req,
                           javax.portlet.ActionResponse res)

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)

getCompany

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

getCompany

Company getCompany(javax.portlet.ActionRequest req)
                   throws com.liferay.portal.PortalException,
                          com.liferay.portal.SystemException
Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException

getCompany

Company getCompany(javax.portlet.RenderRequest req)
                   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 req)

getCompanyId

long getCompanyId(javax.portlet.ActionRequest req)

getCompanyId

long getCompanyId(javax.portlet.PortletRequest req)

getCompanyId

long getCompanyId(javax.portlet.RenderRequest req)

getCompanyIdByWebId

long getCompanyIdByWebId(javax.servlet.ServletContext ctx)

getCompanyIdByWebId

long getCompanyIdByWebId(java.lang.String webId)

getComputerName

java.lang.String getComputerName()

getCurrentURL

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

getCurrentURL

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

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

getHost

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

getHost

java.lang.String getHost(javax.portlet.ActionRequest req)

getHost

java.lang.String getHost(javax.portlet.RenderRequest req)

getHttpServletRequest

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

getHttpServletResponse

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

getLayoutEditPage

java.lang.String getLayoutEditPage(Layout layout)

getLayoutViewPage

java.lang.String getLayoutViewPage(Layout layout)

getLayoutURL

java.lang.String getLayoutURL(ThemeDisplay themeDisplay)
                              throws com.liferay.portal.PortalException,
                                     com.liferay.portal.SystemException
Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException

getLayoutURL

java.lang.String getLayoutURL(Layout layout,
                              ThemeDisplay themeDisplay)
                              throws com.liferay.portal.PortalException,
                                     com.liferay.portal.SystemException
Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException

getLayoutURL

java.lang.String getLayoutURL(Layout layout,
                              ThemeDisplay themeDisplay,
                              boolean doAsUser)
                              throws com.liferay.portal.PortalException,
                                     com.liferay.portal.SystemException
Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException

getLayoutActualURL

java.lang.String getLayoutActualURL(Layout layout)
                                    throws com.liferay.portal.PortalException,
                                           com.liferay.portal.SystemException
Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException

getLayoutActualURL

java.lang.String getLayoutActualURL(Layout layout,
                                    java.lang.String mainPath)
                                    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)
                                    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)
                                      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 req)

getLocale

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

getOriginalServletRequest

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

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()

getPlidIdFromFriendlyURL

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

getPortalLibDir

java.lang.String getPortalLibDir()

getPortalURL

java.lang.String getPortalURL(ThemeDisplay themeDisplay)

getPortalURL

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

getPortalURL

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

getPortalURL

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

getPortalURL

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

getPortalURL

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

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)

getPortletGroupId

long getPortletGroupId(Layout layout)

getPortletGroupId

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

getPortletGroupId

long getPortletGroupId(javax.portlet.ActionRequest req)

getPortletGroupId

long getPortletGroupId(javax.portlet.RenderRequest req)

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,
                                 javax.servlet.ServletContext ctx,
                                 java.util.Locale locale)

getPortletXmlFileName

java.lang.String getPortletXmlFileName()
                                       throws com.liferay.portal.PortalException,
                                              com.liferay.portal.SystemException
Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException

getPreferences

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

getPreferencesValidator

javax.portlet.PreferencesValidator getPreferencesValidator(Portlet portlet)

getSelectedUser

User getSelectedUser(javax.servlet.http.HttpServletRequest req)
                     throws com.liferay.portal.PortalException,
                            java.rmi.RemoteException,
                            com.liferay.portal.SystemException
Throws:
com.liferay.portal.PortalException
java.rmi.RemoteException
com.liferay.portal.SystemException

getSelectedUser

User getSelectedUser(javax.servlet.http.HttpServletRequest req,
                     boolean checkPermission)
                     throws com.liferay.portal.PortalException,
                            java.rmi.RemoteException,
                            com.liferay.portal.SystemException
Throws:
com.liferay.portal.PortalException
java.rmi.RemoteException
com.liferay.portal.SystemException

getSelectedUser

User getSelectedUser(javax.portlet.ActionRequest req)
                     throws com.liferay.portal.PortalException,
                            java.rmi.RemoteException,
                            com.liferay.portal.SystemException
Throws:
com.liferay.portal.PortalException
java.rmi.RemoteException
com.liferay.portal.SystemException

getSelectedUser

User getSelectedUser(javax.portlet.ActionRequest req,
                     boolean checkPermission)
                     throws com.liferay.portal.PortalException,
                            java.rmi.RemoteException,
                            com.liferay.portal.SystemException
Throws:
com.liferay.portal.PortalException
java.rmi.RemoteException
com.liferay.portal.SystemException

getSelectedUser

User getSelectedUser(javax.portlet.RenderRequest req)
                     throws com.liferay.portal.PortalException,
                            java.rmi.RemoteException,
                            com.liferay.portal.SystemException
Throws:
com.liferay.portal.PortalException
java.rmi.RemoteException
com.liferay.portal.SystemException

getSelectedUser

User getSelectedUser(javax.portlet.RenderRequest req,
                     boolean checkPermission)
                     throws com.liferay.portal.PortalException,
                            java.rmi.RemoteException,
                            com.liferay.portal.SystemException
Throws:
com.liferay.portal.PortalException
java.rmi.RemoteException
com.liferay.portal.SystemException

getStrutsAction

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

getSystemCommunityRoles

java.lang.String[] getSystemCommunityRoles()

getSystemGroups

java.lang.String[] getSystemGroups()

getSystemOrganizationRoles

java.lang.String[] getSystemOrganizationRoles()

getSystemRoles

java.lang.String[] getSystemRoles()

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 req)
             throws com.liferay.portal.PortalException,
                    com.liferay.portal.SystemException
Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException

getUser

User getUser(javax.portlet.ActionRequest req)
             throws com.liferay.portal.PortalException,
                    com.liferay.portal.SystemException
Throws:
com.liferay.portal.PortalException
com.liferay.portal.SystemException

getUser

User getUser(javax.portlet.RenderRequest req)
             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 req)

getUserId

long getUserId(javax.portlet.ActionRequest req)

getUserId

long getUserId(javax.portlet.RenderRequest req)

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 req)

getUserName

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

getUserPassword

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

getUserPassword

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

getUserPassword

java.lang.String getUserPassword(javax.portlet.ActionRequest req)

getUserPassword

java.lang.String getUserPassword(javax.portlet.RenderRequest req)

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

isMethodGet

boolean isMethodGet(javax.portlet.PortletRequest req)

isMethodPost

boolean isMethodPost(javax.portlet.PortletRequest req)

isLayoutFriendliable

boolean isLayoutFriendliable(Layout layout)

isLayoutParentable

boolean isLayoutParentable(Layout layout)

isLayoutParentable

boolean isLayoutParentable(java.lang.String type)

isLayoutSitemapable

boolean isLayoutSitemapable(Layout layout)

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(com.liferay.portal.kernel.util.StringMaker sm,
                javax.servlet.ServletContext ctx,
                javax.servlet.http.HttpServletRequest req,
                javax.servlet.http.HttpServletResponse res,
                java.lang.String path)
                throws java.io.IOException,
                       javax.servlet.ServletException
Throws:
java.io.IOException
javax.servlet.ServletException

renderPortlet

void renderPortlet(com.liferay.portal.kernel.util.StringMaker sm,
                   javax.servlet.ServletContext ctx,
                   javax.servlet.http.HttpServletRequest req,
                   javax.servlet.http.HttpServletResponse res,
                   Portlet portlet,
                   java.lang.String queryString)
                   throws java.io.IOException,
                          javax.servlet.ServletException
Throws:
java.io.IOException
javax.servlet.ServletException

renderPortlet

void renderPortlet(com.liferay.portal.kernel.util.StringMaker sm,
                   javax.servlet.ServletContext ctx,
                   javax.servlet.http.HttpServletRequest req,
                   javax.servlet.http.HttpServletResponse res,
                   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(com.liferay.portal.kernel.util.StringMaker sm,
                   javax.servlet.ServletContext ctx,
                   javax.servlet.http.HttpServletRequest req,
                   javax.servlet.http.HttpServletResponse res,
                   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(int status,
               java.lang.Exception e,
               javax.servlet.http.HttpServletRequest req,
               javax.servlet.http.HttpServletResponse res)
               throws java.io.IOException,
                      javax.servlet.ServletException
Throws:
java.io.IOException
javax.servlet.ServletException

setPageSubtitle

void setPageSubtitle(java.lang.String subtitle,
                     javax.servlet.http.HttpServletRequest req)
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 req)
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

storePreferences

void storePreferences(javax.portlet.PortletPreferences prefs)
                      throws java.io.IOException,
                             javax.portlet.ValidatorException
Throws:
java.io.IOException
javax.portlet.ValidatorException

updatePortletMode

javax.portlet.PortletMode updatePortletMode(java.lang.String portletId,
                                            User user,
                                            Layout layout,
                                            javax.portlet.PortletMode portletMode,
                                            javax.servlet.http.HttpServletRequest req)
                                            throws com.liferay.portal.PortalException,
                                                   java.rmi.RemoteException,
                                                   com.liferay.portal.SystemException
Throws:
com.liferay.portal.PortalException
java.rmi.RemoteException
com.liferay.portal.SystemException

updateWindowState

javax.portlet.WindowState updateWindowState(java.lang.String portletId,
                                            User user,
                                            Layout layout,
                                            javax.portlet.WindowState windowState,
                                            javax.servlet.http.HttpServletRequest req)
                                            throws com.liferay.portal.PortalException,
                                                   java.rmi.RemoteException,
                                                   com.liferay.portal.SystemException
Throws:
com.liferay.portal.PortalException
java.rmi.RemoteException
com.liferay.portal.SystemException