Class PortletLocalServiceBaseImpl
- All Implemented Interfaces:
com.liferay.portal.kernel.module.framework.service.IdentifiableOSGiService,com.liferay.portal.kernel.service.BaseLocalService,com.liferay.portal.kernel.service.PersistedModelLocalService,com.liferay.portal.kernel.service.PortletLocalService
- Direct Known Subclasses:
PortletLocalServiceImpl
This implementation exists only as a container for the default service methods generated by ServiceBuilder. All custom service methods should be put in PortletLocalServiceImpl.
- Author:
- Brian Wing Shun Chan
- See Also:
- {$generated.description}
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected com.liferay.counter.kernel.service.CounterLocalServiceprotected com.liferay.portal.kernel.service.PortletLocalServiceprotected com.liferay.portal.kernel.service.persistence.PortletPersistence -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptioncom.liferay.portal.kernel.model.PortletaddPortlet(com.liferay.portal.kernel.model.Portlet portlet) Adds the portlet to the database.voidcom.liferay.portal.kernel.model.PersistedModelcreatePersistedModel(Serializable primaryKeyObj) com.liferay.portal.kernel.model.PortletcreatePortlet(long id) Creates a new portlet with the primary key.com.liferay.portal.kernel.model.PersistedModeldeletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel) com.liferay.portal.kernel.model.PortletdeletePortlet(long id) Deletes the portlet with the primary key from the database.com.liferay.portal.kernel.model.PortletdeletePortlet(com.liferay.portal.kernel.model.Portlet portlet) Deletes the portlet from the database.voiddestroy()<T> TdslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) intdslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) com.liferay.portal.kernel.dao.orm.DynamicQuery<T> List<T>dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.<T> List<T>dynamicQuery(com.liferay.portal.kernel.dao.orm.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(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<T> orderByComparator) Performs a dynamic query on the database and returns an ordered range of the matching rows.longdynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) Returns the number of rows matching the dynamic query.longdynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, com.liferay.portal.kernel.dao.orm.Projection projection) Returns the number of rows matching the dynamic query.com.liferay.portal.kernel.model.PortletfetchPortlet(long id) com.liferay.portal.kernel.dao.orm.ActionableDynamicQuerycom.liferay.portal.kernel.service.persistence.BasePersistence<com.liferay.portal.kernel.model.Portlet>com.liferay.counter.kernel.service.CounterLocalServiceReturns the counter local service.com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQueryprotected Class<?>protected StringReturns the OSGi service identifier.com.liferay.portal.kernel.model.PersistedModelgetPersistedModel(Serializable primaryKeyObj) com.liferay.portal.kernel.model.PortletgetPortlet(long id) Returns the portlet with the primary key.com.liferay.portal.kernel.service.PortletLocalServiceReturns the portlet local service.com.liferay.portal.kernel.service.persistence.PortletPersistenceReturns the portlet persistence.List<com.liferay.portal.kernel.model.Portlet>getPortlets(int start, int end) Returns a range of all the portlets.intReturns the number of portlets.protected voidinitActionableDynamicQuery(com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery actionableDynamicQuery) protected voidPerforms a SQL query.voidsetCounterLocalService(com.liferay.counter.kernel.service.CounterLocalService counterLocalService) Sets the counter local service.voidsetPortletLocalService(com.liferay.portal.kernel.service.PortletLocalService portletLocalService) Sets the portlet local service.voidsetPortletPersistence(com.liferay.portal.kernel.service.persistence.PortletPersistence portletPersistence) Sets the portlet persistence.com.liferay.portal.kernel.model.PortletupdatePortlet(com.liferay.portal.kernel.model.Portlet portlet) Updates the portlet in the database or adds it if it does not yet exist.Methods inherited from class com.liferay.portal.kernel.service.BaseLocalServiceImpl
getClassLoader, getLocalizationMapMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface com.liferay.portal.kernel.service.PersistedModelLocalService
fetchPersistedModelMethods inherited from interface com.liferay.portal.kernel.service.PortletLocalService
addPortletCategory, checkPortlet, checkPortlets, clearCache, clearPortletsMap, clonePortlet, deletePortlet, deletePortlets, deployPortlet, deployRemotePortlet, deployRemotePortlet, deployRemotePortlet, deployRemotePortlet, destroyPortlet, destroyRemotePortlet, fetchPortletById, getCustomAttributesDisplays, getEARDisplay, getFriendlyURLMapperPortlets, getFriendlyURLMappers, getPortletApp, getPortletById, getPortletById, getPortletByStrutsPath, getPortletFriendlyURLMapperMatch, getPortlets, getPortlets, getPortlets, getPortletsCount, getScopablePortlets, getWARDisplay, hasPortlet, initEAR, initWAR, loadGetPortletsMap, removeCompanyPortletsPool, updatePortlet, visitPortlets
-
Field Details
-
portletLocalService
@BeanReference(type=com.liferay.portal.kernel.service.PortletLocalService.class) protected com.liferay.portal.kernel.service.PortletLocalService portletLocalService -
portletPersistence
@BeanReference(type=com.liferay.portal.kernel.service.persistence.PortletPersistence.class) protected com.liferay.portal.kernel.service.persistence.PortletPersistence portletPersistence -
counterLocalService
@BeanReference(type=com.liferay.counter.kernel.service.CounterLocalService.class) protected com.liferay.counter.kernel.service.CounterLocalService counterLocalService
-
-
Constructor Details
-
PortletLocalServiceBaseImpl
public PortletLocalServiceBaseImpl()
-
-
Method Details
-
addPortlet
@Indexable(type=REINDEX) public com.liferay.portal.kernel.model.Portlet addPortlet(com.liferay.portal.kernel.model.Portlet portlet) 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.
- Specified by:
addPortletin interfacecom.liferay.portal.kernel.service.PortletLocalService- Parameters:
portlet- the portlet- Returns:
- the portlet that was added
-
createPortlet
@Transactional(enabled=false) public com.liferay.portal.kernel.model.Portlet createPortlet(long id) Creates a new portlet with the primary key. Does not add the portlet to the database.- Specified by:
createPortletin interfacecom.liferay.portal.kernel.service.PortletLocalService- Parameters:
id- the primary key for the new portlet- Returns:
- the new portlet
-
deletePortlet
@Indexable(type=DELETE) public com.liferay.portal.kernel.model.Portlet deletePortlet(long id) throws com.liferay.portal.kernel.exception.PortalException 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.
- Specified by:
deletePortletin interfacecom.liferay.portal.kernel.service.PortletLocalService- Parameters:
id- the primary key of the portlet- Returns:
- the portlet that was removed
- Throws:
com.liferay.portal.kernel.exception.PortalException- if a portlet with the primary key could not be found
-
deletePortlet
@Indexable(type=DELETE) public com.liferay.portal.kernel.model.Portlet deletePortlet(com.liferay.portal.kernel.model.Portlet portlet) 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.
- Specified by:
deletePortletin interfacecom.liferay.portal.kernel.service.PortletLocalService- Parameters:
portlet- the portlet- Returns:
- the portlet that was removed
-
dslQuery
public <T> T dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) - Specified by:
dslQueryin interfacecom.liferay.portal.kernel.service.PersistedModelLocalService- Specified by:
dslQueryin interfacecom.liferay.portal.kernel.service.PortletLocalService
-
dslQueryCount
public int dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) - Specified by:
dslQueryCountin interfacecom.liferay.portal.kernel.service.PersistedModelLocalService- Specified by:
dslQueryCountin interfacecom.liferay.portal.kernel.service.PortletLocalService
-
dynamicQuery
public com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery()- Specified by:
dynamicQueryin interfacecom.liferay.portal.kernel.service.PortletLocalService
-
dynamicQuery
Performs a dynamic query on the database and returns the matching rows.- Specified by:
dynamicQueryin interfacecom.liferay.portal.kernel.service.PortletLocalService- Parameters:
dynamicQuery- the dynamic query- Returns:
- the matching rows
-
dynamicQuery
public <T> List<T> dynamicQuery(com.liferay.portal.kernel.dao.orm.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 - 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.- Specified by:
dynamicQueryin interfacecom.liferay.portal.kernel.service.PortletLocalService- 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 <T> List<T> dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, int end, com.liferay.portal.kernel.util.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.- Specified by:
dynamicQueryin interfacecom.liferay.portal.kernel.service.PortletLocalService- 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
public long dynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) Returns the number of rows matching the dynamic query.- Specified by:
dynamicQueryCountin interfacecom.liferay.portal.kernel.service.PortletLocalService- Parameters:
dynamicQuery- the dynamic query- Returns:
- the number of rows matching the dynamic query
-
dynamicQueryCount
public long dynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, com.liferay.portal.kernel.dao.orm.Projection projection) Returns the number of rows matching the dynamic query.- Specified by:
dynamicQueryCountin interfacecom.liferay.portal.kernel.service.PortletLocalService- Parameters:
dynamicQuery- the dynamic queryprojection- the projection to apply to the query- Returns:
- the number of rows matching the dynamic query
-
fetchPortlet
public com.liferay.portal.kernel.model.Portlet fetchPortlet(long id) - Specified by:
fetchPortletin interfacecom.liferay.portal.kernel.service.PortletLocalService
-
getPortlet
public com.liferay.portal.kernel.model.Portlet getPortlet(long id) throws com.liferay.portal.kernel.exception.PortalException Returns the portlet with the primary key.- Specified by:
getPortletin interfacecom.liferay.portal.kernel.service.PortletLocalService- Parameters:
id- the primary key of the portlet- Returns:
- the portlet
- Throws:
com.liferay.portal.kernel.exception.PortalException- if a portlet with the primary key could not be found
-
getActionableDynamicQuery
public com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery()- Specified by:
getActionableDynamicQueryin interfacecom.liferay.portal.kernel.service.PortletLocalService
-
getIndexableActionableDynamicQuery
public com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()- Specified by:
getIndexableActionableDynamicQueryin interfacecom.liferay.portal.kernel.service.PortletLocalService
-
initActionableDynamicQuery
protected void initActionableDynamicQuery(com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery actionableDynamicQuery) -
createPersistedModel
public com.liferay.portal.kernel.model.PersistedModel createPersistedModel(Serializable primaryKeyObj) throws com.liferay.portal.kernel.exception.PortalException - Specified by:
createPersistedModelin interfacecom.liferay.portal.kernel.service.PersistedModelLocalService- Specified by:
createPersistedModelin interfacecom.liferay.portal.kernel.service.PortletLocalService- Throws:
com.liferay.portal.kernel.exception.PortalException
-
deletePersistedModel
public com.liferay.portal.kernel.model.PersistedModel deletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel) throws com.liferay.portal.kernel.exception.PortalException - Specified by:
deletePersistedModelin interfacecom.liferay.portal.kernel.service.PersistedModelLocalService- Specified by:
deletePersistedModelin interfacecom.liferay.portal.kernel.service.PortletLocalService- Throws:
com.liferay.portal.kernel.exception.PortalException
-
getBasePersistence
public com.liferay.portal.kernel.service.persistence.BasePersistence<com.liferay.portal.kernel.model.Portlet> getBasePersistence()- Specified by:
getBasePersistencein interfacecom.liferay.portal.kernel.service.PersistedModelLocalService
-
getPersistedModel
public com.liferay.portal.kernel.model.PersistedModel getPersistedModel(Serializable primaryKeyObj) throws com.liferay.portal.kernel.exception.PortalException - Specified by:
getPersistedModelin interfacecom.liferay.portal.kernel.service.PersistedModelLocalService- Specified by:
getPersistedModelin interfacecom.liferay.portal.kernel.service.PortletLocalService- Throws:
com.liferay.portal.kernel.exception.PortalException
-
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.- Specified by:
getPortletsin interfacecom.liferay.portal.kernel.service.PortletLocalService- 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
-
getPortletsCount
public int getPortletsCount()Returns the number of portlets.- Specified by:
getPortletsCountin interfacecom.liferay.portal.kernel.service.PortletLocalService- Returns:
- the number of portlets
-
updatePortlet
@Indexable(type=REINDEX) public com.liferay.portal.kernel.model.Portlet updatePortlet(com.liferay.portal.kernel.model.Portlet portlet) 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.
- Specified by:
updatePortletin interfacecom.liferay.portal.kernel.service.PortletLocalService- Parameters:
portlet- the portlet- Returns:
- the portlet that was updated
-
getPortletLocalService
public com.liferay.portal.kernel.service.PortletLocalService getPortletLocalService()Returns the portlet local service.- Returns:
- the portlet local service
-
setPortletLocalService
public void setPortletLocalService(com.liferay.portal.kernel.service.PortletLocalService portletLocalService) Sets the portlet local service.- Parameters:
portletLocalService- the portlet local service
-
getPortletPersistence
public com.liferay.portal.kernel.service.persistence.PortletPersistence getPortletPersistence()Returns the portlet persistence.- Returns:
- the portlet persistence
-
setPortletPersistence
public void setPortletPersistence(com.liferay.portal.kernel.service.persistence.PortletPersistence portletPersistence) Sets the portlet persistence.- Parameters:
portletPersistence- the portlet persistence
-
getCounterLocalService
public com.liferay.counter.kernel.service.CounterLocalService getCounterLocalService()Returns the counter local service.- Returns:
- the counter local service
-
setCounterLocalService
public void setCounterLocalService(com.liferay.counter.kernel.service.CounterLocalService counterLocalService) Sets the counter local service.- Parameters:
counterLocalService- the counter local service
-
afterPropertiesSet
public void afterPropertiesSet() -
destroy
public void destroy() -
getOSGiServiceIdentifier
Returns the OSGi service identifier.- Specified by:
getOSGiServiceIdentifierin interfacecom.liferay.portal.kernel.module.framework.service.IdentifiableOSGiService- Specified by:
getOSGiServiceIdentifierin interfacecom.liferay.portal.kernel.service.PortletLocalService- Returns:
- the OSGi service identifier
-
getModelClass
-
getModelClassName
-
runSQL
Performs a SQL query.- Parameters:
sql- the sql query
-