Interface PortletLocalService
- All Superinterfaces:
BaseLocalService
,PersistedModelLocalService
- All Known Implementing Classes:
PortletLocalServiceWrapper
- Author:
- Brian Wing Shun Chan
- See Also:
- {$generated.description}
-
Method Summary
Modifier and TypeMethodDescriptionaddPortlet
(Portlet portlet) Adds the portlet to the database.void
addPortletCategory
(long companyId, String categoryName) void
checkPortlet
(Portlet portlet) void
checkPortlets
(long companyId) void
void
clonePortlet
(String portletId) createPersistedModel
(Serializable primaryKeyObj) createPortlet
(long id) Creates a new portlet with the primary key.deletePersistedModel
(PersistedModel persistedModel) deletePortlet
(long id) Deletes the portlet with the primary key from the database.void
deletePortlet
(long companyId, String portletId, long plid) deletePortlet
(Portlet portlet) Deletes the portlet from the database.void
deletePortlets
(long companyId, String[] portletIds, long plid) void
deployPortlet
(Portlet portlet) deployRemotePortlet
(long[] companyIds, Portlet portlet, String[] categoryNames, boolean eagerDestroy, boolean clearCache) deployRemotePortlet
(Portlet portlet, String categoryName) deployRemotePortlet
(Portlet portlet, String[] categoryNames) deployRemotePortlet
(Portlet portlet, String[] categoryNames, boolean eagerDestroy) void
destroyPortlet
(Portlet portlet) void
destroyRemotePortlet
(Portlet portlet) <T> T
dslQuery
(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) int
dslQueryCount
(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) <T> List<T>
dynamicQuery
(DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.<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.<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.long
dynamicQueryCount
(DynamicQuery dynamicQuery) Returns the number of rows matching the dynamic query.long
dynamicQueryCount
(DynamicQuery dynamicQuery, Projection projection) Returns the number of rows matching the dynamic query.fetchPortlet
(long id) fetchPortletById
(long companyId, String portletId) getEARDisplay
(String xml) Returns the OSGi service identifier.getPersistedModel
(Serializable primaryKeyObj) getPortlet
(long id) Returns the portlet with the primary key.getPortletApp
(String servletContextName) getPortletById
(long companyId, String portletId) getPortletById
(String portletId) getPortletByStrutsPath
(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) int
Returns the number of portlets.int
getPortletsCount
(long companyId) getWARDisplay
(String servletContextName, String xml) boolean
hasPortlet
(long companyId, String portletId) void
initEAR
(javax.servlet.ServletContext servletContext, String[] xmls, PluginPackage pluginPackage) initWAR
(String servletContextName, javax.servlet.ServletContext servletContext, String[] xmls, PluginPackage pluginPackage) loadGetPortletsMap
(long companyId) void
removeCompanyPortletsPool
(long companyId) updatePortlet
(long companyId, String portletId, String roles, boolean active) updatePortlet
(Portlet portlet) Updates the portlet in the database or adds it if it does not yet exist.void
visitPortlets
(long companyId, Consumer<Portlet> consumer) Methods inherited from interface com.liferay.portal.kernel.service.PersistedModelLocalService
fetchPersistedModel, getBasePersistence
-
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
-
clearPortletsMap
-
clonePortlet
-
createPersistedModel
- Specified by:
createPersistedModel
in interfacePersistedModelLocalService
- 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
- Specified by:
deletePersistedModel
in interfacePersistedModelLocalService
- 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
- 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
- Throws:
PortalException
-
deployPortlet
- Throws:
Exception
-
deployRemotePortlet
Portlet deployRemotePortlet(long[] companyIds, Portlet portlet, String[] categoryNames, boolean eagerDestroy, boolean clearCache) throws PortalException - Throws:
PortalException
-
deployRemotePortlet
- Throws:
PortalException
-
deployRemotePortlet
- Throws:
PortalException
-
deployRemotePortlet
Portlet deployRemotePortlet(Portlet portlet, String[] categoryNames, boolean eagerDestroy) throws PortalException - Throws:
PortalException
-
destroyPortlet
-
destroyRemotePortlet
-
dslQuery
@Transactional(propagation=SUPPORTS, readOnly=true) <T> T dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) - Specified by:
dslQuery
in interfacePersistedModelLocalService
-
dslQueryCount
@Transactional(propagation=SUPPORTS, readOnly=true) int dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) - Specified by:
dslQueryCount
in interfacePersistedModelLocalService
-
dynamicQuery
-
dynamicQuery
@Transactional(propagation=SUPPORTS, readOnly=true) <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
@Transactional(propagation=SUPPORTS, readOnly=true) <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
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
tocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS
will return the full result set. IforderByComparator
is specified, then the query will include the given ORDER BY logic. IforderByComparator
is 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
@Transactional(propagation=SUPPORTS, readOnly=true) <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
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
tocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS
will return the full result set. IforderByComparator
is specified, then the query will include the given ORDER BY logic. IforderByComparator
is 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
@Transactional(propagation=SUPPORTS, readOnly=true) 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
@Transactional(propagation=SUPPORTS, readOnly=true) long dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection) 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
@Transactional(propagation=SUPPORTS, readOnly=true) ActionableDynamicQuery getActionableDynamicQuery() -
getCustomAttributesDisplays
-
getEARDisplay
-
getFriendlyURLMapperPortlets
-
getFriendlyURLMappers
-
getIndexableActionableDynamicQuery
@Transactional(propagation=SUPPORTS, readOnly=true) IndexableActionableDynamicQuery getIndexableActionableDynamicQuery() -
getOSGiServiceIdentifier
String getOSGiServiceIdentifier()Returns the OSGi service identifier.- Returns:
- the OSGi service identifier
-
getPersistedModel
@Transactional(propagation=SUPPORTS, readOnly=true) PersistedModel getPersistedModel(Serializable primaryKeyObj) throws PortalException - Specified by:
getPersistedModel
in interfacePersistedModelLocalService
- Throws:
PortalException
-
getPortlet
@Transactional(propagation=SUPPORTS, readOnly=true) 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
-
getPortletById
-
getPortletById
-
getPortletByStrutsPath
-
getPortletFriendlyURLMapperMatch
@Transactional(enabled=false) PortletFriendlyURLMapperMatch getPortletFriendlyURLMapperMatch(String url) -
getPortlets
-
getPortlets
Returns a range of all the portlets.Useful when paginating results. Returns a maximum of
end - start
instances.start
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
tocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS
will return the full result set. IforderByComparator
is specified, then the query will include the given ORDER BY logic. IforderByComparator
is 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
@Transactional(enabled=false) List<Portlet> getPortlets(long companyId, boolean showSystem, boolean showPortal) -
getPortletsCount
Returns the number of portlets.- Returns:
- the number of portlets
-
getPortletsCount
-
getScopablePortlets
-
getWARDisplay
-
hasPortlet
-
initEAR
@Transactional(enabled=false) void initEAR(javax.servlet.ServletContext servletContext, String[] xmls, PluginPackage pluginPackage) -
initWAR
@Transactional(enabled=false) List<Portlet> initWAR(String servletContextName, javax.servlet.ServletContext servletContext, String[] xmls, PluginPackage pluginPackage) -
loadGetPortletsMap
@Transactional(propagation=SUPPORTS, readOnly=true) Map<String,Portlet> loadGetPortletsMap(long companyId) -
removeCompanyPortletsPool
-
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
-