Interface PortletItemLocalService
- All Superinterfaces:
BaseLocalService
,PersistedModelLocalService
- All Known Implementing Classes:
PortletItemLocalServiceWrapper
- Author:
- Brian Wing Shun Chan
- See Also:
- {$generated.description}
-
Method Summary
Modifier and TypeMethodDescriptionaddPortletItem
(long userId, long groupId, String name, String portletId, String className) addPortletItem
(PortletItem portletItem) Adds the portlet item to the database.createPersistedModel
(Serializable primaryKeyObj) createPortletItem
(long portletItemId) Creates a new portlet item with the primary key.deletePersistedModel
(PersistedModel persistedModel) deletePortletItem
(long portletItemId) Deletes the portlet item with the primary key from the database.deletePortletItem
(PortletItem portletItem) Deletes the portlet item from the database.<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.fetchPortletItem
(long portletItemId) Returns the OSGi service identifier.getPersistedModel
(Serializable primaryKeyObj) getPortletItem
(long portletItemId) Returns the portlet item with the primary key.getPortletItem
(long groupId, String name, String portletId, String className) getPortletItems
(int start, int end) Returns a range of all the portlet items.getPortletItems
(long groupId, String className) getPortletItems
(long groupId, String portletId, String className) int
Returns the number of portlet items.updatePortletItem
(long userId, long groupId, String name, String portletId, String className) updatePortletItem
(PortletItem portletItem) Updates the portlet item in the database or adds it if it does not yet exist.Methods inherited from interface com.liferay.portal.kernel.service.PersistedModelLocalService
fetchPersistedModel, getBasePersistence
-
Method Details
-
addPortletItem
PortletItem addPortletItem(long userId, long groupId, String name, String portletId, String className) throws PortalException - Throws:
PortalException
-
addPortletItem
Adds the portlet item to the database. Also notifies the appropriate model listeners.Important: Inspect PortletItemLocalServiceImpl 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:
portletItem
- the portlet item- Returns:
- the portlet item that was added
-
createPersistedModel
- Specified by:
createPersistedModel
in interfacePersistedModelLocalService
- Throws:
PortalException
-
createPortletItem
Creates a new portlet item with the primary key. Does not add the portlet item to the database.- Parameters:
portletItemId
- the primary key for the new portlet item- Returns:
- the new portlet item
-
deletePersistedModel
- Specified by:
deletePersistedModel
in interfacePersistedModelLocalService
- Throws:
PortalException
-
deletePortletItem
Deletes the portlet item with the primary key from the database. Also notifies the appropriate model listeners.Important: Inspect PortletItemLocalServiceImpl 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:
portletItemId
- the primary key of the portlet item- Returns:
- the portlet item that was removed
- Throws:
PortalException
- if a portlet item with the primary key could not be found
-
deletePortletItem
Deletes the portlet item from the database. Also notifies the appropriate model listeners.Important: Inspect PortletItemLocalServiceImpl 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:
portletItem
- the portlet item- Returns:
- the portlet item that was removed
-
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.PortletItemModelImpl
.- 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.PortletItemModelImpl
.- 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
-
fetchPortletItem
@Transactional(propagation=SUPPORTS, readOnly=true) PortletItem fetchPortletItem(long portletItemId) -
getActionableDynamicQuery
@Transactional(propagation=SUPPORTS, readOnly=true) ActionableDynamicQuery getActionableDynamicQuery() -
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
-
getPortletItem
@Transactional(propagation=SUPPORTS, readOnly=true) PortletItem getPortletItem(long portletItemId) throws PortalException Returns the portlet item with the primary key.- Parameters:
portletItemId
- the primary key of the portlet item- Returns:
- the portlet item
- Throws:
PortalException
- if a portlet item with the primary key could not be found
-
getPortletItem
@Transactional(propagation=SUPPORTS, readOnly=true) PortletItem getPortletItem(long groupId, String name, String portletId, String className) throws PortalException - Throws:
PortalException
-
getPortletItems
@Transactional(propagation=SUPPORTS, readOnly=true) List<PortletItem> getPortletItems(int start, int end) Returns a range of all the portlet items.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.PortletItemModelImpl
.- Parameters:
start
- the lower bound of the range of portlet itemsend
- the upper bound of the range of portlet items (not inclusive)- Returns:
- the range of portlet items
-
getPortletItems
@Transactional(propagation=SUPPORTS, readOnly=true) List<PortletItem> getPortletItems(long groupId, String className) -
getPortletItems
@Transactional(propagation=SUPPORTS, readOnly=true) List<PortletItem> getPortletItems(long groupId, String portletId, String className) -
getPortletItemsCount
Returns the number of portlet items.- Returns:
- the number of portlet items
-
updatePortletItem
PortletItem updatePortletItem(long userId, long groupId, String name, String portletId, String className) throws PortalException - Throws:
PortalException
-
updatePortletItem
Updates the portlet item in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.Important: Inspect PortletItemLocalServiceImpl 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:
portletItem
- the portlet item- Returns:
- the portlet item that was updated
-