Class PortletLocalServiceUtil
com.liferay.portal.service.impl.PortletLocalServiceImpl and
is an 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.- Author:
- Brian Wing Shun Chan
- See Also:
- {$generated.description}
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic PortletaddPortlet(Portlet portlet) Adds the portlet to the database.static voidaddPortletCategory(long companyId, String categoryName) static voidcheckPortlet(Portlet portlet) static voidcheckPortlets(long companyId) static voidstatic voidstatic PortletclonePortlet(String portletId) static PersistedModelcreatePersistedModel(Serializable primaryKeyObj) static PortletcreatePortlet(long id) Creates a new portlet with the primary key.static PersistedModeldeletePersistedModel(PersistedModel persistedModel) static PortletdeletePortlet(long id) Deletes the portlet with the primary key from the database.static voiddeletePortlet(long companyId, String portletId, long plid) static PortletdeletePortlet(Portlet portlet) Deletes the portlet from the database.static voiddeletePortlets(long companyId, String[] portletIds, long plid) static voiddeployPortlet(Portlet portlet) static PortletdeployRemotePortlet(long[] companyIds, Portlet portlet, String[] categoryNames, boolean eagerDestroy, boolean clearCache) static PortletdeployRemotePortlet(Portlet portlet, String categoryName) static PortletdeployRemotePortlet(Portlet portlet, String[] categoryNames) static PortletdeployRemotePortlet(Portlet portlet, String[] categoryNames, boolean eagerDestroy) static voiddestroyPortlet(Portlet portlet) static voiddestroyRemotePortlet(Portlet portlet) static <T> TdslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) static intdslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) static DynamicQuerystatic <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 longdynamicQueryCount(DynamicQuery dynamicQuery) Returns the number of rows matching the dynamic query.static longdynamicQueryCount(DynamicQuery dynamicQuery, Projection projection) Returns the number of rows matching the dynamic query.static PortletfetchPortlet(long id) static PortletfetchPortletById(long companyId, String portletId) static ActionableDynamicQuerystatic List<CustomAttributesDisplay>static PortletCategorygetEARDisplay(String xml) static List<FriendlyURLMapper>static StringReturns the OSGi service identifier.static PersistedModelgetPersistedModel(Serializable primaryKeyObj) static PortletgetPortlet(long id) Returns the portlet with the primary key.static PortletAppgetPortletApp(String servletContextName) static PortletgetPortletById(long companyId, String portletId) static PortletgetPortletById(String portletId) static PortletgetPortletByStrutsPath(long companyId, String strutsPath) getPortlets(int start, int end) Returns a range of all the portlets.getPortlets(long companyId) getPortlets(long companyId, boolean showSystem, boolean showPortal) static intReturns the number of portlets.static intgetPortletsCount(long companyId) static PortletLocalServicestatic PortletCategorygetWARDisplay(String servletContextName, String xml) static booleanhasPortlet(long companyId, String portletId) static voidinitEAR(javax.servlet.ServletContext servletContext, String[] xmls, PluginPackage pluginPackage) initWAR(String servletContextName, javax.servlet.ServletContext servletContext, String[] xmls, PluginPackage pluginPackage) loadGetPortletsMap(long companyId) static voidremoveCompanyPortletsPool(long companyId) static voidsetService(PortletLocalService service) static PortletupdatePortlet(long companyId, String portletId, String roles, boolean active) static PortletupdatePortlet(Portlet portlet) Updates the portlet in the database or adds it if it does not yet exist.static voidvisitPortlets(long companyId, Consumer<Portlet> consumer)
-
Constructor Details
-
PortletLocalServiceUtil
public PortletLocalServiceUtil()
-
-
Method Details
-
addPortlet
Adds the portlet to the database. Also notifies the appropriate model listeners.Important: Inspect PortletLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.
- Parameters:
portlet- the portlet- Returns:
- the portlet that was added
-
addPortletCategory
-
checkPortlet
- Throws:
PortalException
-
checkPortlets
- Throws:
PortalException
-
clearCache
public static void clearCache() -
clearPortletsMap
public static void clearPortletsMap() -
clonePortlet
-
createPersistedModel
public static PersistedModel createPersistedModel(Serializable primaryKeyObj) throws PortalException - Throws:
PortalException
-
createPortlet
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
Deletes the portlet with the primary key from the database. Also notifies the appropriate model listeners.Important: Inspect PortletLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.
- 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 void deletePortlet(long companyId, String portletId, long plid) throws PortalException - Throws:
PortalException
-
deletePortlet
Deletes the portlet from the database. Also notifies the appropriate model listeners.Important: Inspect PortletLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.
- 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
-
deployPortlet
- Throws:
Exception
-
deployRemotePortlet
public static Portlet deployRemotePortlet(long[] companyIds, Portlet portlet, String[] categoryNames, boolean eagerDestroy, boolean clearCache) 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
-
destroyRemotePortlet
-
dslQuery
public static <T> T dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) -
dslQueryCount
public static int dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) -
dynamicQuery
-
dynamicQuery
Performs a dynamic query on the database and returns the matching rows.- Parameters:
dynamicQuery- the dynamic query- Returns:
- the matching rows
-
dynamicQuery
Performs a dynamic query on the database and returns a range of the matching rows.Useful when paginating results. Returns a maximum of
end - startinstances.startandendare not primary keys, they are indexes in the result set. Thus,0refers to the first result in the set. Setting bothstartandendtocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POSwill return the full result set. IforderByComparatoris specified, then the query will include the given ORDER BY logic. IforderByComparatoris absent, then the query will include the default ORDER BY logic fromcom.liferay.portal.model.impl.PortletModelImpl.- Parameters:
dynamicQuery- the dynamic querystart- the lower bound of the range of model instancesend- 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 - startinstances.startandendare not primary keys, they are indexes in the result set. Thus,0refers to the first result in the set. Setting bothstartandendtocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POSwill return the full result set. IforderByComparatoris specified, then the query will include the given ORDER BY logic. IforderByComparatoris absent, then the query will include the default ORDER BY logic fromcom.liferay.portal.model.impl.PortletModelImpl.- Parameters:
dynamicQuery- the dynamic querystart- the lower bound of the range of model instancesend- the upper bound of the range of model instances (not inclusive)orderByComparator- the comparator to order the results by (optionallynull)- Returns:
- the ordered range of matching rows
-
dynamicQueryCount
Returns the number of rows matching the dynamic query.- Parameters:
dynamicQuery- the dynamic query- Returns:
- the number of rows matching the dynamic query
-
dynamicQueryCount
Returns the number of rows matching the dynamic query.- Parameters:
dynamicQuery- the dynamic queryprojection- the projection to apply to the query- Returns:
- the number of rows matching the dynamic query
-
fetchPortlet
-
fetchPortletById
-
getActionableDynamicQuery
-
getCustomAttributesDisplays
-
getEARDisplay
-
getFriendlyURLMapperPortlets
-
getFriendlyURLMappers
-
getIndexableActionableDynamicQuery
-
getOSGiServiceIdentifier
Returns the OSGi service identifier.- Returns:
- the OSGi service identifier
-
getPersistedModel
- Throws:
PortalException
-
getPortlet
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
-
getPortletById
-
getPortletById
-
getPortletByStrutsPath
-
getPortletFriendlyURLMapperMatch
-
getPortlets
-
getPortlets
Returns a range of all the portlets.Useful when paginating results. Returns a maximum of
end - startinstances.startandendare not primary keys, they are indexes in the result set. Thus,0refers to the first result in the set. Setting bothstartandendtocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POSwill return the full result set. IforderByComparatoris specified, then the query will include the given ORDER BY logic. IforderByComparatoris absent, then the query will include the default ORDER BY logic fromcom.liferay.portal.model.impl.PortletModelImpl.- Parameters:
start- the lower bound of the range of portletsend- the upper bound of the range of portlets (not inclusive)- Returns:
- the range of portlets
-
getPortlets
-
getPortlets
-
getPortletsCount
public static int getPortletsCount()Returns the number of portlets.- Returns:
- the number of portlets
-
getPortletsCount
public static int getPortletsCount(long companyId) -
getScopablePortlets
-
getWARDisplay
-
hasPortlet
-
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
-
removeCompanyPortletsPool
public static void removeCompanyPortletsPool(long companyId) -
updatePortlet
-
updatePortlet
Updates the portlet in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.Important: Inspect PortletLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.
- Parameters:
portlet- the portlet- Returns:
- the portlet that was updated
-
visitPortlets
-
getService
-
setService
-