com.liferay.portal.service
Class PortletItemLocalServiceUtil

java.lang.Object
  com.liferay.portal.service.PortletItemLocalServiceUtil

public class PortletItemLocalServiceUtil
extends Object

The utility for the portlet item local service. This utility wraps PortletItemLocalServiceImpl and is the primary access point for service operations in application layer code running on the local server.

This is a local service. 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.

See Also:

PortletItemLocalService, PortletItemLocalServiceBaseImpl, PortletItemLocalServiceImpl

ServiceBuilder generated this class. Modifications in this class will be overwritten the next time it is generated.

Constructor Summary

PortletItemLocalServiceUtil()

Method Summary

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 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 List	dynamicQuery(DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.
static List	dynamicQuery(DynamicQuery dynamicQuery, int start, int end) Performs a dynamic query on the database and returns a range of the matching rows.
static List	dynamicQuery(DynamicQuery dynamicQuery, int start, int end, OrderByComparator 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 that match the dynamic query.
static PortletItem	fetchPortletItem(long portletItemId)
static String	getBeanIdentifier() Returns the Spring bean ID for this bean.
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 void	setBeanIdentifier(String beanIdentifier) Sets the Spring bean ID for this bean.
void	setService(PortletItemLocalService service) Deprecated.
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.
static PortletItem	updatePortletItem(PortletItem portletItem, boolean merge) Updates the portlet item in the database or adds it if it does not yet exist.

Methods inherited from class java.lang.Object

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

Constructor Detail

PortletItemLocalServiceUtil

public PortletItemLocalServiceUtil()

Method Detail

addPortletItem

public static PortletItem addPortletItem(PortletItem portletItem)
                                  throws SystemException

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

Throws:

SystemException - if a system exception occurred

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

deletePortletItem

public static PortletItem deletePortletItem(long portletItemId)
                                     throws PortalException,
                                            SystemException

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

SystemException - if a system exception occurred

deletePortletItem

public static PortletItem deletePortletItem(PortletItem portletItem)
                                     throws SystemException

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

Throws:

SystemException - if a system exception occurred

dynamicQuery

public static DynamicQuery dynamicQuery()

dynamicQuery

public static List dynamicQuery(DynamicQuery dynamicQuery)
                         throws SystemException

Performs a dynamic query on the database and returns the matching rows.

Parameters:

dynamicQuery - the dynamic query

Returns:

the matching rows

Throws:

SystemException - if a system exception occurred

dynamicQuery

public static List dynamicQuery(DynamicQuery dynamicQuery,
                                int start,
                                int end)
                         throws SystemException

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.

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

Throws:

SystemException - if a system exception occurred

dynamicQuery

public static List dynamicQuery(DynamicQuery dynamicQuery,
                                int start,
                                int end,
                                OrderByComparator orderByComparator)
                         throws SystemException

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.

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

Throws:

SystemException - if a system exception occurred

dynamicQueryCount

public static long dynamicQueryCount(DynamicQuery dynamicQuery)
                              throws SystemException

Returns the number of rows that match the dynamic query.

Parameters:

dynamicQuery - the dynamic query

Returns:

the number of rows that match the dynamic query

Throws:

SystemException - if a system exception occurred

fetchPortletItem

public static PortletItem fetchPortletItem(long portletItemId)
                                    throws SystemException

Throws:

SystemException

getPortletItem

public static PortletItem getPortletItem(long portletItemId)
                                  throws PortalException,
                                         SystemException

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

SystemException - if a system exception occurred

getPersistedModel

public static PersistedModel getPersistedModel(Serializable primaryKeyObj)
                                        throws PortalException,
                                               SystemException

Throws:

PortalException

SystemException

getPortletItems

public static List<PortletItem> getPortletItems(int start,
                                                int end)
                                         throws SystemException

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.

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

Throws:

SystemException - if a system exception occurred

getPortletItemsCount

public static int getPortletItemsCount()
                                throws SystemException

Returns the number of portlet items.

Returns:

the number of portlet items

Throws:

SystemException - if a system exception occurred

updatePortletItem

public static PortletItem updatePortletItem(PortletItem portletItem)
                                     throws SystemException

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

Throws:

SystemException - if a system exception occurred

updatePortletItem

public static PortletItem updatePortletItem(PortletItem portletItem,
                                            boolean merge)
                                     throws SystemException

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

merge - whether to merge the portlet item with the current session. See BatchSession.update(com.liferay.portal.kernel.dao.orm.Session, com.liferay.portal.model.BaseModel, boolean) for an explanation.

Returns:

the portlet item that was updated

Throws:

SystemException - if a system exception occurred

getBeanIdentifier

public static String getBeanIdentifier()

Returns the Spring bean ID for this bean.

Returns:

the Spring bean ID for this bean

setBeanIdentifier

public static void setBeanIdentifier(String beanIdentifier)

Sets the Spring bean ID for this bean.

Parameters:

beanIdentifier - the Spring bean ID for this bean

addPortletItem

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

Throws:

PortalException

SystemException

getPortletItem

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

Throws:

PortalException

SystemException

getPortletItems

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

Throws:

SystemException

getPortletItems

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

Throws:

SystemException

updatePortletItem

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

Throws:

PortalException

SystemException

getService

public static PortletItemLocalService getService()

setService

public void setService(PortletItemLocalService service)

Deprecated.