Liferay 7.0-ce-b4

com.liferay.portal.service
Class PortletLocalServiceUtil

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

@ProviderType
public class PortletLocalServiceUtil
extends Object

Provides the local service utility for Portlet. This utility wraps com.liferay.portal.service.impl.PortletLocalServiceImpl and is the primary access point for service operations in application layer code running on the local server. 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, com.liferay.portal.service.impl.PortletLocalServiceImpl

Constructor Summary
PortletLocalServiceUtil()
           
 
Method Summary
static Portlet addPortlet(Portlet portlet)
          Adds the portlet to the database.
static void addPortletCategory(long companyId, String categoryName)
           
static void checkPortlet(Portlet portlet)
           
static void checkPortlets(long companyId)
           
static void clearCache()
           
static void clearCompanyPortletsPool()
          Deprecated. As of 7.0.0, replaced by #clearPortletsMap)
static void clearPortletsMap()
           
static Portlet clonePortlet(long companyId, String portletId)
          Deprecated. As of 6.1.0, replaced by clonePortlet(String)
static Portlet clonePortlet(String portletId)
           
static Portlet createPortlet(long id)
          Creates a new portlet with the primary key.
static PersistedModel deletePersistedModel(PersistedModel persistedModel)
           
static Portlet deletePortlet(long id)
          Deletes the portlet with the primary key from the database.
static void deletePortlet(long companyId, String portletId, long plid)
           
static Portlet deletePortlet(Portlet portlet)
          Deletes the portlet from the database.
static void deletePortlets(long companyId, String[] portletIds, long plid)
           
static Portlet deployRemotePortlet(Portlet portlet, String categoryName)
           
static Portlet deployRemotePortlet(Portlet portlet, String[] categoryNames)
           
static Portlet deployRemotePortlet(Portlet portlet, String[] categoryNames, boolean eagerDestroy)
           
static void destroyPortlet(Portlet portlet)
           
static void destroyRemotePortlet(Portlet portlet)
           
static DynamicQuery dynamicQuery()
           
static
<T> List<T>
dynamicQuery(DynamicQuery dynamicQuery)
          Performs a dynamic query on the database and returns the matching rows.
static
<T> List<T>
dynamicQuery(DynamicQuery dynamicQuery, int start, int end)
          Performs a dynamic query on the database and returns a range of the matching rows.
static
<T> List<T>
dynamicQuery(DynamicQuery dynamicQuery, int start, int end, OrderByComparator<T> orderByComparator)
          Performs a dynamic query on the database and returns an ordered range of the matching rows.
static long dynamicQueryCount(DynamicQuery dynamicQuery)
          Returns the number of rows matching the dynamic query.
static long dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection)
          Returns the number of rows matching the dynamic query.
static Portlet fetchPortlet(long id)
           
static ActionableDynamicQuery getActionableDynamicQuery()
           
static List<CustomAttributesDisplay> getCustomAttributesDisplays()
           
static PortletCategory getEARDisplay(String xml)
           
static List<Portlet> getFriendlyURLMapperPortlets()
           
static List<FriendlyURLMapper> getFriendlyURLMappers()
           
static IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()
           
static String getOSGiServiceIdentifier()
          Returns the OSGi service identifier.
static PersistedModel getPersistedModel(Serializable primaryKeyObj)
           
static Portlet getPortlet(long id)
          Returns 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)
          Returns 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()
          Returns the number of portlets.
static List<Portlet> getScopablePortlets()
           
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)
           
static Map<String,Portlet> loadGetPortletsMap(long companyId)
           
static Map<String,Portlet> loadGetPortletsPool(long companyId)
          Deprecated. As of 7.0.0, replaced by #loadGetPortletsMap(long))
static void removeCompanyPortletsPool(long companyId)
           
static Portlet updatePortlet(long companyId, String portletId, String roles, boolean active)
           
static Portlet updatePortlet(Portlet portlet)
          Updates the portlet in the database or adds it if it does not yet exist.
 
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)
Adds the portlet to the database. Also notifies the appropriate model listeners.

Parameters:
portlet - the portlet
Returns:
the portlet that was added

addPortletCategory

public static void addPortletCategory(long companyId,
                                      String categoryName)

checkPortlet

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

checkPortlets

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

clearCache

public static void clearCache()

clearCompanyPortletsPool

@Deprecated
public static void clearCompanyPortletsPool()
Deprecated. As of 7.0.0, replaced by #clearPortletsMap)


clearPortletsMap

public static void clearPortletsMap()

clonePortlet

@Deprecated
public static Portlet clonePortlet(long companyId,
                                              String portletId)
Deprecated. As of 6.1.0, replaced by clonePortlet(String)


clonePortlet

public static Portlet clonePortlet(String portletId)

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

deletePersistedModel

public static PersistedModel deletePersistedModel(PersistedModel persistedModel)
                                           throws PortalException
Throws:
PortalException

deletePortlet

public static void deletePortlet(long companyId,
                                 String portletId,
                                 long plid)
                          throws PortalException
Throws:
PortalException

deletePortlet

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

Parameters:
id - the primary key of the portlet
Returns:
the portlet that was removed
Throws:
PortalException - if a portlet with the primary key could not be found

deletePortlet

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

Parameters:
portlet - the portlet
Returns:
the portlet that was removed

deletePortlets

public static void deletePortlets(long companyId,
                                  String[] portletIds,
                                  long plid)
                           throws PortalException
Throws:
PortalException

deployRemotePortlet

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

deployRemotePortlet

public static Portlet deployRemotePortlet(Portlet portlet,
                                          String[] categoryNames)
                                   throws PortalException
Throws:
PortalException

deployRemotePortlet

public static Portlet deployRemotePortlet(Portlet portlet,
                                          String[] categoryNames,
                                          boolean eagerDestroy)
                                   throws PortalException
Throws:
PortalException

destroyPortlet

public static void destroyPortlet(Portlet portlet)

destroyRemotePortlet

public static void destroyRemotePortlet(Portlet portlet)

dynamicQuery

public static DynamicQuery dynamicQuery()

dynamicQuery

public static <T> List<T> dynamicQuery(DynamicQuery dynamicQuery)
Performs a dynamic query on the database and returns the matching rows.

Parameters:
dynamicQuery - the dynamic query
Returns:
the matching rows

dynamicQuery

public static <T> List<T> dynamicQuery(DynamicQuery dynamicQuery,
                                       int start,
                                       int end)
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. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent and pagination is required (start and end are not QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from PortletModelImpl. If both orderByComparator and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.

Parameters:
dynamicQuery - the dynamic query
start - the lower bound of the range of model instances
end - the upper bound of the range of model instances (not inclusive)
Returns:
the range of matching rows

dynamicQuery

public static <T> List<T> dynamicQuery(DynamicQuery dynamicQuery,
                                       int start,
                                       int end,
                                       OrderByComparator<T> orderByComparator)
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. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent and pagination is required (start and end are not QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from PortletModelImpl. If both orderByComparator and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.

Parameters:
dynamicQuery - the dynamic query
start - the lower bound of the range of model instances
end - the upper bound of the range of model instances (not inclusive)
orderByComparator - the comparator to order the results by (optionally null)
Returns:
the ordered range of matching rows

dynamicQueryCount

public static long dynamicQueryCount(DynamicQuery dynamicQuery)
Returns the number of rows matching the dynamic query.

Parameters:
dynamicQuery - the dynamic query
Returns:
the number of rows matching the dynamic query

dynamicQueryCount

public static long dynamicQueryCount(DynamicQuery dynamicQuery,
                                     Projection projection)
Returns the number of rows matching the dynamic query.

Parameters:
dynamicQuery - the dynamic query
projection - the projection to apply to the query
Returns:
the number of rows matching the dynamic query

fetchPortlet

public static Portlet fetchPortlet(long id)

getActionableDynamicQuery

public static ActionableDynamicQuery getActionableDynamicQuery()

getCustomAttributesDisplays

public static List<CustomAttributesDisplay> getCustomAttributesDisplays()

getEARDisplay

public static PortletCategory getEARDisplay(String xml)

getFriendlyURLMapperPortlets

public static List<Portlet> getFriendlyURLMapperPortlets()

getFriendlyURLMappers

public static List<FriendlyURLMapper> getFriendlyURLMappers()

getIndexableActionableDynamicQuery

public static IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()

getOSGiServiceIdentifier

public static String getOSGiServiceIdentifier()
Returns the OSGi service identifier.

Returns:
the OSGi service identifier

getPersistedModel

public static PersistedModel getPersistedModel(Serializable primaryKeyObj)
                                        throws PortalException
Throws:
PortalException

getPortlet

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

Parameters:
id - the primary key of the portlet
Returns:
the portlet
Throws:
PortalException - if a portlet with the primary key could not be found

getPortletApp

public static PortletApp getPortletApp(String servletContextName)

getPortletById

public static Portlet getPortletById(long companyId,
                                     String portletId)

getPortletById

public static Portlet getPortletById(String portletId)

getPortletByStrutsPath

public static Portlet getPortletByStrutsPath(long companyId,
                                             String strutsPath)

getPortlets

public static List<Portlet> getPortlets()

getPortlets

public static List<Portlet> getPortlets(long companyId)

getPortlets

public static List<Portlet> getPortlets(long companyId,
                                        boolean showSystem,
                                        boolean showPortal)

getPortlets

public static List<Portlet> getPortlets(int start,
                                        int end)
Returns 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. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent and pagination is required (start and end are not QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from PortletModelImpl. If both orderByComparator and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.

Parameters:
start - the lower bound of the range of portlets
end - the upper bound of the range of portlets (not inclusive)
Returns:
the range of portlets

getPortletsCount

public static int getPortletsCount()
Returns the number of portlets.

Returns:
the number of portlets

getScopablePortlets

public static List<Portlet> getScopablePortlets()

getWARDisplay

public static PortletCategory getWARDisplay(String servletContextName,
                                            String xml)

hasPortlet

public static boolean hasPortlet(long companyId,
                                 String portletId)

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)

loadGetPortletsMap

public static Map<String,Portlet> loadGetPortletsMap(long companyId)

loadGetPortletsPool

@Deprecated
public static Map<String,Portlet> loadGetPortletsPool(long companyId)
Deprecated. As of 7.0.0, replaced by #loadGetPortletsMap(long))


removeCompanyPortletsPool

public static void removeCompanyPortletsPool(long companyId)

updatePortlet

public static Portlet updatePortlet(long companyId,
                                    String portletId,
                                    String roles,
                                    boolean active)

updatePortlet

public static Portlet updatePortlet(Portlet portlet)
Updates the portlet in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

Parameters:
portlet - the portlet
Returns:
the portlet that was updated

getService

public static PortletLocalService getService()

Liferay 7.0-ce-b4