com.liferay.portal.kernel.service

Class PortletItemLocalServiceUtil

Object

com.liferay.portal.kernel.service.PortletItemLocalServiceUtil

@ProviderType
public class PortletItemLocalServiceUtil
extends Object

Provides the local service utility for PortletItem. This utility wraps PortletItemLocalServiceImpl and is the primary 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:

PortletItemLocalService, PortletItemLocalServiceBaseImpl, PortletItemLocalServiceImpl

{$generated.description}

Constructor Summary

Constructors

Constructor and Description
PortletItemLocalServiceUtil()

Method Summary

Modifier and Type	Method and Description
static PortletItem	addPortletItem(long userId, long groupId, String name, String portletId, String className)
static PortletItem	addPortletItem(PortletItem portletItem) Adds the portlet item to the database.
static PortletItem	createPortletItem(long portletItemId) Creates a new portlet item with the primary key.
static PersistedModel	deletePersistedModel(PersistedModel persistedModel)
static PortletItem	deletePortletItem(long portletItemId) Deletes the portlet item with the primary key from the database.
static PortletItem	deletePortletItem(PortletItem portletItem) Deletes the portlet item from the database.
static DynamicQuery	dynamicQuery()
static <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 long	dynamicQueryCount(DynamicQuery dynamicQuery) Returns the number of rows matching the dynamic query.
static long	dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection) Returns the number of rows matching the dynamic query.
static PortletItem	fetchPortletItem(long portletItemId)
static ActionableDynamicQuery	getActionableDynamicQuery()
static IndexableActionableDynamicQuery	getIndexableActionableDynamicQuery()
static String	getOSGiServiceIdentifier() Returns the OSGi service identifier.
static PersistedModel	getPersistedModel(Serializable primaryKeyObj)
static PortletItem	getPortletItem(long portletItemId) Returns the portlet item with the primary key.
static PortletItem	getPortletItem(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 int	getPortletItemsCount() Returns the number of portlet items.
static PortletItemLocalService	getService()
static PortletItem	updatePortletItem(long userId, long groupId, String name, String portletId, String className)
static PortletItem	updatePortletItem(PortletItem portletItem) Updates the portlet item in the database or adds it if it does not yet exist.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PortletItemLocalServiceUtil

public PortletItemLocalServiceUtil()

Method Detail

addPortletItem

public static PortletItem addPortletItem(long userId,
                                         long groupId,
                                         String name,
                                         String portletId,
                                         String className)
                                  throws PortalException

Throws:

PortalException

addPortletItem

public static PortletItem addPortletItem(PortletItem portletItem)

Adds the portlet item to the database. Also notifies the appropriate model listeners.

Parameters:

portletItem - the portlet item

Returns:

the portlet item that was added

createPortletItem

public static PortletItem createPortletItem(long portletItemId)

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

public static PortletItem deletePortletItem(long portletItemId)
                                     throws PortalException

Deletes the portlet item with the primary key from the database. Also notifies the appropriate model listeners.

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

public static PortletItem deletePortletItem(PortletItem portletItem)

Deletes the portlet item from the database. Also notifies the appropriate model listeners.

Parameters:

portletItem - the portlet item

Returns:

the portlet item that was removed

dynamicQuery

public static DynamicQuery dynamicQuery()

dynamicQuery

public static <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

public 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.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent and pagination is required (start and end are not QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from PortletItemModelImpl. If both orderByComparator and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.

Parameters:

dynamicQuery - the dynamic query

start - the lower bound of the range of model instances

end - 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 - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent and pagination is required (start and end are not QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from PortletItemModelImpl. If both orderByComparator and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.

Parameters:

dynamicQuery - the dynamic query

start - the lower bound of the range of model instances

end - the upper bound of the range of model instances (not inclusive)

orderByComparator - the comparator to order the results by (optionally null)

Returns:

the ordered range of matching rows

dynamicQueryCount

public static 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

public static long dynamicQueryCount(DynamicQuery dynamicQuery,
                                     Projection projection)

Returns the number of rows matching the dynamic query.

Parameters:

dynamicQuery - the dynamic query

projection - the projection to apply to the query

Returns:

the number of rows matching the dynamic query

fetchPortletItem

public static PortletItem fetchPortletItem(long portletItemId)

getActionableDynamicQuery

public static ActionableDynamicQuery getActionableDynamicQuery()

getIndexableActionableDynamicQuery

public static IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()

getOSGiServiceIdentifier

public static String getOSGiServiceIdentifier()

Returns the OSGi service identifier.

Returns:

the OSGi service identifier

getPersistedModel

public static PersistedModel getPersistedModel(Serializable primaryKeyObj)
                                        throws PortalException

Throws:

PortalException

getPortletItem

public static 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

public static PortletItem getPortletItem(long groupId,
                                         String name,
                                         String portletId,
                                         String className)
                                  throws PortalException

Throws:

PortalException

getPortletItems

public static 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 and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to QueryUtil.ALL_POS will return the full result set. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent and pagination is required (start and end are not QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from PortletItemModelImpl. If both orderByComparator and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.

Parameters:

start - the lower bound of the range of portlet items

end - the upper bound of the range of portlet items (not inclusive)

Returns:

the range of portlet items

getPortletItems

public static List<PortletItem> getPortletItems(long groupId,
                                                String className)

getPortletItems

public static List<PortletItem> getPortletItems(long groupId,
                                                String portletId,
                                                String className)

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

public static PortletItem updatePortletItem(PortletItem portletItem)

Updates the portlet item in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

Parameters:

portletItem - the portlet item

Returns:

the portlet item that was updated

getService

public static PortletItemLocalService getService()