com.liferay.site.navigation.service

Interface SiteNavigationMenuItemLocalService

All Superinterfaces:

BaseLocalService, PersistedModelLocalService

All Known Implementing Classes:

SiteNavigationMenuItemLocalServiceWrapper

@ProviderType
 @Transactional(isolation=PORTAL,
               rollbackFor={PortalException.class,SystemException.class})
public interface SiteNavigationMenuItemLocalService
extends BaseLocalService, PersistedModelLocalService

Provides the local service interface for SiteNavigationMenuItem. 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:

SiteNavigationMenuItemLocalServiceUtil

Method Summary

Modifier and Type	Method and Description
SiteNavigationMenuItem	addSiteNavigationMenuItem(long userId, long groupId, long siteNavigationMenuId, long parentSiteNavigationMenuItemId, java.lang.String type, int order, java.lang.String typeSettings, ServiceContext serviceContext)
SiteNavigationMenuItem	addSiteNavigationMenuItem(long userId, long groupId, long siteNavigationMenuId, long parentSiteNavigationMenuItemId, java.lang.String type, java.lang.String typeSettings, ServiceContext serviceContext)
SiteNavigationMenuItem	addSiteNavigationMenuItem(SiteNavigationMenuItem siteNavigationMenuItem) Adds the site navigation menu item to the database.
PersistedModel	createPersistedModel(java.io.Serializable primaryKeyObj)
SiteNavigationMenuItem	createSiteNavigationMenuItem(long siteNavigationMenuItemId) Creates a new site navigation menu item with the primary key.
PersistedModel	deletePersistedModel(PersistedModel persistedModel)
SiteNavigationMenuItem	deleteSiteNavigationMenuItem(long siteNavigationMenuItemId) Deletes the site navigation menu item with the primary key from the database.
SiteNavigationMenuItem	deleteSiteNavigationMenuItem(SiteNavigationMenuItem siteNavigationMenuItem) Deletes the site navigation menu item from the database.
void	deleteSiteNavigationMenuItems(long siteNavigationMenuId)
void	deleteSiteNavigationMenuItemsByGroupId(long groupId)
<T> T	dslQuery(DSLQuery dslQuery)
DynamicQuery	dynamicQuery()
<T> java.util.List<T>	dynamicQuery(DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.
<T> java.util.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> java.util.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.
SiteNavigationMenuItem	fetchSiteNavigationMenuItem(long siteNavigationMenuItemId)
SiteNavigationMenuItem	fetchSiteNavigationMenuItemByUuidAndGroupId(java.lang.String uuid, long groupId) Returns the site navigation menu item matching the UUID and group.
ActionableDynamicQuery	getActionableDynamicQuery()
ExportActionableDynamicQuery	getExportActionableDynamicQuery(PortletDataContext portletDataContext)
IndexableActionableDynamicQuery	getIndexableActionableDynamicQuery()
java.lang.String	getOSGiServiceIdentifier() Returns the OSGi service identifier.
PersistedModel	getPersistedModel(java.io.Serializable primaryKeyObj)
SiteNavigationMenuItem	getSiteNavigationMenuItem(long siteNavigationMenuItemId) Returns the site navigation menu item with the primary key.
SiteNavigationMenuItem	getSiteNavigationMenuItemByUuidAndGroupId(java.lang.String uuid, long groupId) Returns the site navigation menu item matching the UUID and group.
java.util.List<SiteNavigationMenuItem>	getSiteNavigationMenuItems(int start, int end) Returns a range of all the site navigation menu items.
java.util.List<SiteNavigationMenuItem>	getSiteNavigationMenuItems(long siteNavigationMenuId)
java.util.List<SiteNavigationMenuItem>	getSiteNavigationMenuItems(long siteNavigationMenuId, long parentSiteNavigationMenuItemId)
java.util.List<SiteNavigationMenuItem>	getSiteNavigationMenuItemsByUuidAndCompanyId(java.lang.String uuid, long companyId) Returns all the site navigation menu items matching the UUID and company.
java.util.List<SiteNavigationMenuItem>	getSiteNavigationMenuItemsByUuidAndCompanyId(java.lang.String uuid, long companyId, int start, int end, OrderByComparator<SiteNavigationMenuItem> orderByComparator) Returns a range of site navigation menu items matching the UUID and company.
int	getSiteNavigationMenuItemsCount() Returns the number of site navigation menu items.
int	getSiteNavigationMenuItemsCount(long siteNavigationMenuId)
SiteNavigationMenuItem	updateSiteNavigationMenuItem(long siteNavigationMenuItemId, long parentSiteNavigationMenuItemId, int order)
SiteNavigationMenuItem	updateSiteNavigationMenuItem(long userId, long siteNavigationMenuItemId, long groupId, long siteNavigationMenuId, long parentSiteNavigationMenuItemId, java.lang.String type, int order, java.lang.String typeSettings)
SiteNavigationMenuItem	updateSiteNavigationMenuItem(long userId, long siteNavigationMenuItemId, java.lang.String typeSettings, ServiceContext serviceContext)
SiteNavigationMenuItem	updateSiteNavigationMenuItem(SiteNavigationMenuItem siteNavigationMenuItem) Updates the site navigation menu item in the database or adds it if it does not yet exist.

Methods inherited from interface com.liferay.portal.kernel.service.PersistedModelLocalService

getBasePersistence

Method Detail

addSiteNavigationMenuItem

SiteNavigationMenuItem addSiteNavigationMenuItem(long userId,
                                                 long groupId,
                                                 long siteNavigationMenuId,
                                                 long parentSiteNavigationMenuItemId,
                                                 java.lang.String type,
                                                 int order,
                                                 java.lang.String typeSettings,
                                                 ServiceContext serviceContext)
                                          throws PortalException

Throws:

PortalException

addSiteNavigationMenuItem

SiteNavigationMenuItem addSiteNavigationMenuItem(long userId,
                                                 long groupId,
                                                 long siteNavigationMenuId,
                                                 long parentSiteNavigationMenuItemId,
                                                 java.lang.String type,
                                                 java.lang.String typeSettings,
                                                 ServiceContext serviceContext)
                                          throws PortalException

Throws:

PortalException

addSiteNavigationMenuItem

@Indexable(type=REINDEX)
SiteNavigationMenuItem addSiteNavigationMenuItem(SiteNavigationMenuItem siteNavigationMenuItem)

Adds the site navigation menu item to the database. Also notifies the appropriate model listeners.

Parameters:

siteNavigationMenuItem - the site navigation menu item

Returns:

the site navigation menu item that was added

createPersistedModel

PersistedModel createPersistedModel(java.io.Serializable primaryKeyObj)
                             throws PortalException

Specified by:

createPersistedModel in interface PersistedModelLocalService

Throws:

PortalException

createSiteNavigationMenuItem

@Transactional(enabled=false)
SiteNavigationMenuItem createSiteNavigationMenuItem(long siteNavigationMenuItemId)

Creates a new site navigation menu item with the primary key. Does not add the site navigation menu item to the database.

Parameters:

siteNavigationMenuItemId - the primary key for the new site navigation menu item

Returns:

the new site navigation menu item

deletePersistedModel

PersistedModel deletePersistedModel(PersistedModel persistedModel)
                             throws PortalException

Specified by:

deletePersistedModel in interface PersistedModelLocalService

Throws:

PortalException

deleteSiteNavigationMenuItem

@Indexable(type=DELETE)
SiteNavigationMenuItem deleteSiteNavigationMenuItem(long siteNavigationMenuItemId)
                                                                     throws PortalException

Deletes the site navigation menu item with the primary key from the database. Also notifies the appropriate model listeners.

Parameters:

siteNavigationMenuItemId - the primary key of the site navigation menu item

Returns:

the site navigation menu item that was removed

Throws:

PortalException - if a site navigation menu item with the primary key could not be found

deleteSiteNavigationMenuItem

@Indexable(type=DELETE)
 @SystemEvent(type=1)
SiteNavigationMenuItem deleteSiteNavigationMenuItem(SiteNavigationMenuItem siteNavigationMenuItem)

Deletes the site navigation menu item from the database. Also notifies the appropriate model listeners.

Parameters:

siteNavigationMenuItem - the site navigation menu item

Returns:

the site navigation menu item that was removed

deleteSiteNavigationMenuItems

void deleteSiteNavigationMenuItems(long siteNavigationMenuId)

deleteSiteNavigationMenuItemsByGroupId

void deleteSiteNavigationMenuItemsByGroupId(long groupId)

dslQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
<T> T dslQuery(DSLQuery dslQuery)

dynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
DynamicQuery dynamicQuery()

dynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
<T> java.util.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> java.util.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 com.liferay.portal.kernel.dao.orm.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, then the query will include the default ORDER BY logic from com.liferay.site.navigation.model.impl.SiteNavigationMenuItemModelImpl.

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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
<T> java.util.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 com.liferay.portal.kernel.dao.orm.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, then the query will include the default ORDER BY logic from com.liferay.site.navigation.model.impl.SiteNavigationMenuItemModelImpl.

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

@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 query

projection - the projection to apply to the query

Returns:

the number of rows matching the dynamic query

fetchSiteNavigationMenuItem

@Transactional(propagation=SUPPORTS,
               readOnly=true)
SiteNavigationMenuItem fetchSiteNavigationMenuItem(long siteNavigationMenuItemId)

fetchSiteNavigationMenuItemByUuidAndGroupId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
SiteNavigationMenuItem fetchSiteNavigationMenuItemByUuidAndGroupId(java.lang.String uuid,
                                                                                                                                      long groupId)

Returns the site navigation menu item matching the UUID and group.

Parameters:

uuid - the site navigation menu item's UUID

groupId - the primary key of the group

Returns:

the matching site navigation menu item, or null if a matching site navigation menu item could not be found

getActionableDynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
ActionableDynamicQuery getActionableDynamicQuery()

getExportActionableDynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
ExportActionableDynamicQuery getExportActionableDynamicQuery(PortletDataContext portletDataContext)

getIndexableActionableDynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()

getOSGiServiceIdentifier

java.lang.String getOSGiServiceIdentifier()

Returns the OSGi service identifier.

Returns:

the OSGi service identifier

getPersistedModel

@Transactional(propagation=SUPPORTS,
               readOnly=true)
PersistedModel getPersistedModel(java.io.Serializable primaryKeyObj)
                                                                                             throws PortalException

Specified by:

getPersistedModel in interface PersistedModelLocalService

Throws:

PortalException

getSiteNavigationMenuItem

@Transactional(propagation=SUPPORTS,
               readOnly=true)
SiteNavigationMenuItem getSiteNavigationMenuItem(long siteNavigationMenuItemId)
                                                                                                             throws PortalException

Returns the site navigation menu item with the primary key.

Parameters:

siteNavigationMenuItemId - the primary key of the site navigation menu item

Returns:

the site navigation menu item

Throws:

PortalException - if a site navigation menu item with the primary key could not be found

getSiteNavigationMenuItemByUuidAndGroupId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
SiteNavigationMenuItem getSiteNavigationMenuItemByUuidAndGroupId(java.lang.String uuid,
                                                                                                                                    long groupId)
                                                                                                                             throws PortalException

Returns the site navigation menu item matching the UUID and group.

Parameters:

uuid - the site navigation menu item's UUID

groupId - the primary key of the group

Returns:

the matching site navigation menu item

Throws:

PortalException - if a matching site navigation menu item could not be found

getSiteNavigationMenuItems

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<SiteNavigationMenuItem> getSiteNavigationMenuItems(int start,
                                                                                                                                     int end)

Returns a range of all the site navigation menu 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 com.liferay.portal.kernel.dao.orm.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, then the query will include the default ORDER BY logic from com.liferay.site.navigation.model.impl.SiteNavigationMenuItemModelImpl.

Parameters:

start - the lower bound of the range of site navigation menu items

end - the upper bound of the range of site navigation menu items (not inclusive)

Returns:

the range of site navigation menu items

getSiteNavigationMenuItems

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<SiteNavigationMenuItem> getSiteNavigationMenuItems(long siteNavigationMenuId)

getSiteNavigationMenuItems

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<SiteNavigationMenuItem> getSiteNavigationMenuItems(long siteNavigationMenuId,
                                                                                                                                     long parentSiteNavigationMenuItemId)

getSiteNavigationMenuItemsByUuidAndCompanyId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<SiteNavigationMenuItem> getSiteNavigationMenuItemsByUuidAndCompanyId(java.lang.String uuid,
                                                                                                                                                       long companyId)

Returns all the site navigation menu items matching the UUID and company.

Parameters:

uuid - the UUID of the site navigation menu items

companyId - the primary key of the company

Returns:

the matching site navigation menu items, or an empty list if no matches were found

getSiteNavigationMenuItemsByUuidAndCompanyId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<SiteNavigationMenuItem> getSiteNavigationMenuItemsByUuidAndCompanyId(java.lang.String uuid,
                                                                                                                                                       long companyId,
                                                                                                                                                       int start,
                                                                                                                                                       int end,
                                                                                                                                                       OrderByComparator<SiteNavigationMenuItem> orderByComparator)

Returns a range of site navigation menu items matching the UUID and company.

Parameters:

uuid - the UUID of the site navigation menu items

companyId - the primary key of the company

start - the lower bound of the range of site navigation menu items

end - the upper bound of the range of site navigation menu items (not inclusive)

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

Returns:

the range of matching site navigation menu items, or an empty list if no matches were found

getSiteNavigationMenuItemsCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getSiteNavigationMenuItemsCount()

Returns the number of site navigation menu items.

Returns:

the number of site navigation menu items

getSiteNavigationMenuItemsCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getSiteNavigationMenuItemsCount(long siteNavigationMenuId)

updateSiteNavigationMenuItem

SiteNavigationMenuItem updateSiteNavigationMenuItem(long siteNavigationMenuItemId,
                                                    long parentSiteNavigationMenuItemId,
                                                    int order)
                                             throws PortalException

Throws:

PortalException

updateSiteNavigationMenuItem

SiteNavigationMenuItem updateSiteNavigationMenuItem(long userId,
                                                    long siteNavigationMenuItemId,
                                                    long groupId,
                                                    long siteNavigationMenuId,
                                                    long parentSiteNavigationMenuItemId,
                                                    java.lang.String type,
                                                    int order,
                                                    java.lang.String typeSettings)
                                             throws PortalException

Throws:

PortalException

updateSiteNavigationMenuItem

SiteNavigationMenuItem updateSiteNavigationMenuItem(long userId,
                                                    long siteNavigationMenuItemId,
                                                    java.lang.String typeSettings,
                                                    ServiceContext serviceContext)
                                             throws PortalException

Throws:

PortalException

updateSiteNavigationMenuItem

@Indexable(type=REINDEX)
SiteNavigationMenuItem updateSiteNavigationMenuItem(SiteNavigationMenuItem siteNavigationMenuItem)

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

Parameters:

siteNavigationMenuItem - the site navigation menu item

Returns:

the site navigation menu item that was updated