com.liferay.portal.service
Interface PortletItemLocalService

All Known Implementing Classes:

PortletItemLocalServiceBaseImpl, PortletItemLocalServiceImpl, PortletItemLocalServiceWrapper

@Transactional(isolation=PORTAL,
               rollbackFor={PortalException.class,SystemException.class})
public interface PortletItemLocalService

The interface for the portlet item local service.

Never modify or reference this interface directly. Always use PortletItemLocalServiceUtil to access the portlet item local service. Add custom service methods to PortletItemLocalServiceImpl and rerun ServiceBuilder to automatically copy the method declarations to this interface.

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:

PortletItemLocalServiceUtil, PortletItemLocalServiceBaseImpl, PortletItemLocalServiceImpl

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

Method Summary

PortletItem	addPortletItem(long userId, long groupId, String name, String portletId, String className)
PortletItem	addPortletItem(PortletItem portletItem) Adds the portlet item to the database.
PortletItem	createPortletItem(long portletItemId) Creates a new portlet item with the primary key.
void	deletePortletItem(long portletItemId) Deletes the portlet item with the primary key from the database.
void	deletePortletItem(PortletItem portletItem) Deletes the portlet item from the database.
List	dynamicQuery(DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.
List	dynamicQuery(DynamicQuery dynamicQuery, int start, int end) Performs a dynamic query on the database and returns a range of the matching rows.
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.
long	dynamicQueryCount(DynamicQuery dynamicQuery) Counts the number of rows that match the dynamic query.
PortletItem	getPortletItem(long portletItemId) Gets the portlet item with the primary key.
PortletItem	getPortletItem(long groupId, String name, String portletId, String className)
List<PortletItem>	getPortletItems(int start, int end) Gets a range of all the portlet items.
List<PortletItem>	getPortletItems(long groupId, String className)
List<PortletItem>	getPortletItems(long groupId, String portletId, String className)
int	getPortletItemsCount() Gets the number of portlet items.
PortletItem	updatePortletItem(long userId, long groupId, String name, String portletId, String className)
PortletItem	updatePortletItem(PortletItem portletItem) Updates the portlet item in the database.
PortletItem	updatePortletItem(PortletItem portletItem, boolean merge) Updates the portlet item in the database.

Method Detail

addPortletItem

PortletItem addPortletItem(PortletItem portletItem)
                           throws SystemException

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

Parameters:

portletItem - the portlet item to add

Returns:

the portlet item that was added

Throws:

SystemException - if a system exception occurred

createPortletItem

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

void 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 to delete

Throws:

PortalException - if a portlet item with the primary key could not be found

SystemException - if a system exception occurred

deletePortletItem

void deletePortletItem(PortletItem portletItem)
                       throws SystemException

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

Parameters:

portletItem - the portlet item to delete

Throws:

SystemException - if a system exception occurred

dynamicQuery

List dynamicQuery(DynamicQuery dynamicQuery)
                  throws SystemException

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

Parameters:

dynamicQuery - the dynamic query to search with

Returns:

the matching rows

Throws:

SystemException - if a system exception occurred

dynamicQuery

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 to search with

start - the lower bound of the range of model instances to return

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

Returns:

the range of matching rows

Throws:

SystemException - if a system exception occurred

dynamicQuery

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 to search with

start - the lower bound of the range of model instances to return

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

orderByComparator - the comparator to order the results by

Returns:

the ordered range of matching rows

Throws:

SystemException - if a system exception occurred

dynamicQueryCount

long dynamicQueryCount(DynamicQuery dynamicQuery)
                       throws SystemException

Counts the number of rows that match the dynamic query.

Parameters:

dynamicQuery - the dynamic query to search with

Returns:

the number of rows that match the dynamic query

Throws:

SystemException - if a system exception occurred

getPortletItem

@Transactional(propagation=SUPPORTS,
               readOnly=true)
PortletItem getPortletItem(long portletItemId)
                           throws PortalException,
                                  SystemException

Gets the portlet item with the primary key.

Parameters:

portletItemId - the primary key of the portlet item to get

Returns:

the portlet item

Throws:

PortalException - if a portlet item with the primary key could not be found

SystemException - if a system exception occurred

getPortletItems

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<PortletItem> getPortletItems(int start,
                                                                           int end)
                                  throws SystemException

Gets 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 to return

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

Returns:

the range of portlet items

Throws:

SystemException - if a system exception occurred

getPortletItemsCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getPortletItemsCount()
                         throws SystemException

Gets the number of portlet items.

Returns:

the number of portlet items

Throws:

SystemException - if a system exception occurred

updatePortletItem

PortletItem updatePortletItem(PortletItem portletItem)
                              throws SystemException

Updates the portlet item in the database. Also notifies the appropriate model listeners.

Parameters:

portletItem - the portlet item to update

Returns:

the portlet item that was updated

Throws:

SystemException - if a system exception occurred

updatePortletItem

PortletItem updatePortletItem(PortletItem portletItem,
                              boolean merge)
                              throws SystemException

Updates the portlet item in the database. Also notifies the appropriate model listeners.

Parameters:

portletItem - the portlet item to update

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

addPortletItem

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

Throws:

PortalException

SystemException

getPortletItem

@Transactional(propagation=SUPPORTS,
               readOnly=true)
PortletItem getPortletItem(long groupId,
                                                                    String name,
                                                                    String portletId,
                                                                    String className)
                           throws PortalException,
                                  SystemException

Throws:

PortalException

SystemException

getPortletItems

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<PortletItem> getPortletItems(long groupId,
                                                                           String className)
                                  throws SystemException

Throws:

SystemException

getPortletItems

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<PortletItem> getPortletItems(long groupId,
                                                                           String portletId,
                                                                           String className)
                                  throws SystemException

Throws:

SystemException

updatePortletItem

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

Throws:

PortalException

SystemException