Class PortletItemLocalServiceUtil
com.liferay.portal.service.impl.PortletItemLocalServiceImpl 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 PortletItemaddPortletItem(long userId, long groupId, String name, String portletId, String className) static PortletItemaddPortletItem(PortletItem portletItem) Adds the portlet item to the database.static PersistedModelcreatePersistedModel(Serializable primaryKeyObj) static PortletItemcreatePortletItem(long portletItemId) Creates a new portlet item with the primary key.static PersistedModeldeletePersistedModel(PersistedModel persistedModel) static PortletItemdeletePortletItem(long portletItemId) Deletes the portlet item with the primary key from the database.static PortletItemdeletePortletItem(PortletItem portletItem) Deletes the portlet item from the database.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 PortletItemfetchPortletItem(long portletItemId) static ActionableDynamicQuerystatic StringReturns the OSGi service identifier.static PersistedModelgetPersistedModel(Serializable primaryKeyObj) static PortletItemgetPortletItem(long portletItemId) Returns the portlet item with the primary key.static PortletItemgetPortletItem(long groupId, String name, String portletId, String className) static List<PortletItem>getPortletItems(int start, int end) Returns a range of all the portlet items.static List<PortletItem>getPortletItems(long groupId, String className) static List<PortletItem>getPortletItems(long groupId, String portletId, String className) static intReturns the number of portlet items.static PortletItemLocalServicestatic voidsetService(PortletItemLocalService service) static PortletItemupdatePortletItem(long userId, long groupId, String name, String portletId, String className) static PortletItemupdatePortletItem(PortletItem portletItem) Updates the portlet item in the database or adds it if it does not yet exist.
-
Constructor Details
-
PortletItemLocalServiceUtil
public PortletItemLocalServiceUtil()
-
-
Method Details
-
addPortletItem
public static 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
public static PersistedModel createPersistedModel(Serializable primaryKeyObj) throws PortalException - 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
public static PersistedModel deletePersistedModel(PersistedModel persistedModel) throws PortalException - 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
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.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
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.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
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
-
fetchPortletItem
-
getActionableDynamicQuery
-
getIndexableActionableDynamicQuery
-
getOSGiServiceIdentifier
Returns the OSGi service identifier.- Returns:
- the OSGi service identifier
-
getPersistedModel
- Throws:
PortalException
-
getPortletItem
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
public static PortletItem getPortletItem(long groupId, String name, String portletId, String className) throws PortalException - Throws:
PortalException
-
getPortletItems
Returns a range of all the portlet items.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.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
-
getPortletItems
-
getPortletItemsCount
public static int getPortletItemsCount()Returns the number of portlet items.- Returns:
- the number of portlet items
-
updatePortletItem
public static 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
-
getService
-
setService
-