Liferay 6.0.5

com.liferay.portal.service
Class PortletLocalServiceUtil

java.lang.Object
  extended by com.liferay.portal.service.PortletLocalServiceUtil

public class PortletLocalServiceUtil
extends Object

The utility for the portlet local service. This utility wraps PortletLocalServiceImpl and is the primary access point for service operations in application layer code running on the local server.

Never modify this class directly. Add custom service methods to PortletLocalServiceImpl and rerun ServiceBuilder to regenerate this class.

This is a local service. Methods of this service will not have security checks based on the propagated JAAS credentials because this service can only be accessed from within the same VM.

See Also:
PortletLocalService, PortletLocalServiceBaseImpl, PortletLocalServiceImpl
ServiceBuilder generated this class. Modifications in this class will be overwritten the next time is generated.

Constructor Summary
PortletLocalServiceUtil()
           
 
Method Summary
static Portlet addPortlet(Portlet portlet)
          Adds the portlet to the database.
static void checkPortlet(Portlet portlet)
           
static void checkPortlets(long companyId)
           
static void clearCache()
           
static Portlet clonePortlet(long companyId, String portletId)
           
static Portlet createPortlet(long id)
          Creates a new portlet with the primary key.
static void deletePortlet(long id)
          Deletes the portlet with the primary key from the database.
static void deletePortlet(Portlet portlet)
          Deletes the portlet from the database.
static Portlet deployRemotePortlet(Portlet portlet, String categoryName)
           
static void destroyPortlet(Portlet portlet)
           
static void destroyRemotePortlet(Portlet portlet)
           
static List dynamicQuery(DynamicQuery dynamicQuery)
          Performs a dynamic query on the database and returns the matching rows.
static List dynamicQuery(DynamicQuery dynamicQuery, int start, int end)
          Performs a dynamic query on the database and returns a range of the matching rows.
static List dynamicQuery(DynamicQuery dynamicQuery, int start, int end, OrderByComparator orderByComparator)
          Performs a dynamic query on the database and returns an ordered range of the matching rows.
static long dynamicQueryCount(DynamicQuery dynamicQuery)
          Counts the number of rows that match the dynamic query.
static List<CustomAttributesDisplay> getCustomAttributesDisplays()
           
static PortletCategory getEARDisplay(String xml)
           
static List<Portlet> getFriendlyURLMapperPortlets()
           
static List<FriendlyURLMapper> getFriendlyURLMappers()
           
static Portlet getPortlet(long id)
          Gets the portlet with the primary key.
static PortletApp getPortletApp(String servletContextName)
           
static Portlet getPortletById(long companyId, String portletId)
           
static Portlet getPortletById(String portletId)
           
static Portlet getPortletByStrutsPath(long companyId, String strutsPath)
           
static List<Portlet> getPortlets()
           
static List<Portlet> getPortlets(int start, int end)
          Gets a range of all the portlets.
static List<Portlet> getPortlets(long companyId)
           
static List<Portlet> getPortlets(long companyId, boolean showSystem, boolean showPortal)
           
static int getPortletsCount()
          Gets the number of portlets.
static PortletLocalService getService()
           
static PortletCategory getWARDisplay(String servletContextName, String xml)
           
static boolean hasPortlet(long companyId, String portletId)
           
static void initEAR(javax.servlet.ServletContext servletContext, String[] xmls, PluginPackage pluginPackage)
           
static List<Portlet> initWAR(String servletContextName, javax.servlet.ServletContext servletContext, String[] xmls, PluginPackage pluginPackage)
           
 void setService(PortletLocalService service)
           
static Portlet updatePortlet(long companyId, String portletId, String roles, boolean active)
           
static Portlet updatePortlet(Portlet portlet)
          Updates the portlet in the database.
static Portlet updatePortlet(Portlet portlet, boolean merge)
          Updates the portlet in the database.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

PortletLocalServiceUtil

public PortletLocalServiceUtil()
Method Detail

addPortlet

public static Portlet addPortlet(Portlet portlet)
                          throws SystemException
Adds the portlet to the database. Also notifies the appropriate model listeners.

Parameters:
portlet - the portlet to add
Returns:
the portlet that was added
Throws:
SystemException - if a system exception occurred

createPortlet

public static Portlet createPortlet(long id)
Creates a new portlet with the primary key. Does not add the portlet to the database.

Parameters:
id - the primary key for the new portlet
Returns:
the new portlet

deletePortlet

public static void deletePortlet(long id)
                          throws PortalException,
                                 SystemException
Deletes the portlet with the primary key from the database. Also notifies the appropriate model listeners.

Parameters:
id - the primary key of the portlet to delete
Throws:
PortalException - if a portlet with the primary key could not be found
SystemException - if a system exception occurred

deletePortlet

public static void deletePortlet(Portlet portlet)
                          throws SystemException
Deletes the portlet from the database. Also notifies the appropriate model listeners.

Parameters:
portlet - the portlet to delete
Throws:
SystemException - if a system exception occurred

dynamicQuery

public static List dynamicQuery(DynamicQuery dynamicQuery)
                         throws SystemException
Performs a dynamic query on the database and returns the matching rows.

Parameters:
dynamicQuery - the dynamic query to search with
Returns:
the matching rows
Throws:
SystemException - if a system exception occurred

dynamicQuery

public static List dynamicQuery(DynamicQuery dynamicQuery,
                                int start,
                                int end)
                         throws SystemException
Performs a dynamic query on the database and returns a range of the matching rows.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set.

Parameters:
dynamicQuery - the dynamic query to search with
start - the lower bound of the range of model instances to return
end - the upper bound of the range of model instances to return (not inclusive)
Returns:
the range of matching rows
Throws:
SystemException - if a system exception occurred

dynamicQuery

public static List dynamicQuery(DynamicQuery dynamicQuery,
                                int start,
                                int end,
                                OrderByComparator orderByComparator)
                         throws SystemException
Performs a dynamic query on the database and returns an ordered range of the matching rows.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set.

Parameters:
dynamicQuery - the dynamic query to search with
start - the lower bound of the range of model instances to return
end - the upper bound of the range of model instances to return (not inclusive)
orderByComparator - the comparator to order the results by
Returns:
the ordered range of matching rows
Throws:
SystemException - if a system exception occurred

dynamicQueryCount

public static long dynamicQueryCount(DynamicQuery dynamicQuery)
                              throws SystemException
Counts the number of rows that match the dynamic query.

Parameters:
dynamicQuery - the dynamic query to search with
Returns:
the number of rows that match the dynamic query
Throws:
SystemException - if a system exception occurred

getPortlet

public static Portlet getPortlet(long id)
                          throws PortalException,
                                 SystemException
Gets the portlet with the primary key.

Parameters:
id - the primary key of the portlet to get
Returns:
the portlet
Throws:
PortalException - if a portlet with the primary key could not be found
SystemException - if a system exception occurred

getPortlets

public static List<Portlet> getPortlets(int start,
                                        int end)
                                 throws SystemException
Gets a range of all the portlets.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set.

Parameters:
start - the lower bound of the range of portlets to return
end - the upper bound of the range of portlets to return (not inclusive)
Returns:
the range of portlets
Throws:
SystemException - if a system exception occurred

getPortletsCount

public static int getPortletsCount()
                            throws SystemException
Gets the number of portlets.

Returns:
the number of portlets
Throws:
SystemException - if a system exception occurred

updatePortlet

public static Portlet updatePortlet(Portlet portlet)
                             throws SystemException
Updates the portlet in the database. Also notifies the appropriate model listeners.

Parameters:
portlet - the portlet to update
Returns:
the portlet that was updated
Throws:
SystemException - if a system exception occurred

updatePortlet

public static Portlet updatePortlet(Portlet portlet,
                                    boolean merge)
                             throws SystemException
Updates the portlet in the database. Also notifies the appropriate model listeners.

Parameters:
portlet - the portlet to update
merge - whether to merge the portlet with the current session. See BatchSession.update(com.liferay.portal.kernel.dao.orm.Session, com.liferay.portal.model.BaseModel, boolean) for an explanation.
Returns:
the portlet that was updated
Throws:
SystemException - if a system exception occurred

checkPortlet

public static void checkPortlet(Portlet portlet)
                         throws PortalException,
                                SystemException
Throws:
PortalException
SystemException

checkPortlets

public static void checkPortlets(long companyId)
                          throws PortalException,
                                 SystemException
Throws:
PortalException
SystemException

clearCache

public static void clearCache()

clonePortlet

public static Portlet clonePortlet(long companyId,
                                   String portletId)
                            throws SystemException
Throws:
SystemException

deployRemotePortlet

public static Portlet deployRemotePortlet(Portlet portlet,
                                          String categoryName)
                                   throws SystemException
Throws:
SystemException

destroyPortlet

public static void destroyPortlet(Portlet portlet)

destroyRemotePortlet

public static void destroyRemotePortlet(Portlet portlet)

getCustomAttributesDisplays

public static List<CustomAttributesDisplay> getCustomAttributesDisplays()

getEARDisplay

public static PortletCategory getEARDisplay(String xml)
                                     throws SystemException
Throws:
SystemException

getFriendlyURLMapperPortlets

public static List<Portlet> getFriendlyURLMapperPortlets()

getFriendlyURLMappers

public static List<FriendlyURLMapper> getFriendlyURLMappers()

getPortletApp

public static PortletApp getPortletApp(String servletContextName)

getPortletById

public static Portlet getPortletById(long companyId,
                                     String portletId)
                              throws SystemException
Throws:
SystemException

getPortletById

public static Portlet getPortletById(String portletId)

getPortletByStrutsPath

public static Portlet getPortletByStrutsPath(long companyId,
                                             String strutsPath)
                                      throws SystemException
Throws:
SystemException

getPortlets

public static List<Portlet> getPortlets()

getPortlets

public static List<Portlet> getPortlets(long companyId)
                                 throws SystemException
Throws:
SystemException

getPortlets

public static List<Portlet> getPortlets(long companyId,
                                        boolean showSystem,
                                        boolean showPortal)
                                 throws SystemException
Throws:
SystemException

getWARDisplay

public static PortletCategory getWARDisplay(String servletContextName,
                                            String xml)
                                     throws SystemException
Throws:
SystemException

hasPortlet

public static boolean hasPortlet(long companyId,
                                 String portletId)
                          throws SystemException
Throws:
SystemException

initEAR

public static void initEAR(javax.servlet.ServletContext servletContext,
                           String[] xmls,
                           PluginPackage pluginPackage)

initWAR

public static List<Portlet> initWAR(String servletContextName,
                                    javax.servlet.ServletContext servletContext,
                                    String[] xmls,
                                    PluginPackage pluginPackage)

updatePortlet

public static Portlet updatePortlet(long companyId,
                                    String portletId,
                                    String roles,
                                    boolean active)
                             throws SystemException
Throws:
SystemException

getService

public static PortletLocalService getService()

setService

public void setService(PortletLocalService service)

Liferay 6.0.5