com.liferay.site.navigation.service

Class SiteNavigationMenuLocalServiceUtil

java.lang.Object

com.liferay.site.navigation.service.SiteNavigationMenuLocalServiceUtil

public class SiteNavigationMenuLocalServiceUtil
extends java.lang.Object

Provides the local service utility for SiteNavigationMenu. This utility wraps com.liferay.site.navigation.service.impl.SiteNavigationMenuLocalServiceImpl 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.

See Also:

SiteNavigationMenuLocalService

Generated:

Constructor Summary

Constructors

Constructor and Description
SiteNavigationMenuLocalServiceUtil()

Method Summary

Modifier and Type	Method and Description
static SiteNavigationMenu	addSiteNavigationMenu(long userId, long groupId, java.lang.String name, int type, boolean auto, com.liferay.portal.kernel.service.ServiceContext serviceContext)
static SiteNavigationMenu	addSiteNavigationMenu(long userId, long groupId, java.lang.String name, int type, com.liferay.portal.kernel.service.ServiceContext serviceContext)
static SiteNavigationMenu	addSiteNavigationMenu(long userId, long groupId, java.lang.String name, com.liferay.portal.kernel.service.ServiceContext serviceContext)
static SiteNavigationMenu	addSiteNavigationMenu(SiteNavigationMenu siteNavigationMenu) Adds the site navigation menu to the database.
static com.liferay.portal.kernel.model.PersistedModel	createPersistedModel(java.io.Serializable primaryKeyObj)
static SiteNavigationMenu	createSiteNavigationMenu(long siteNavigationMenuId) Creates a new site navigation menu with the primary key.
static com.liferay.portal.kernel.model.PersistedModel	deletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel)
static SiteNavigationMenu	deleteSiteNavigationMenu(long siteNavigationMenuId) Deletes the site navigation menu with the primary key from the database.
static SiteNavigationMenu	deleteSiteNavigationMenu(SiteNavigationMenu siteNavigationMenu) Deletes the site navigation menu from the database.
static void	deleteSiteNavigationMenus(long groupId)
static <T> T	dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)
static com.liferay.portal.kernel.dao.orm.DynamicQuery	dynamicQuery()
static <T> java.util.List<T>	dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.
static <T> java.util.List<T>	dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, int end) Performs a dynamic query on the database and returns a range of the matching rows.
static <T> java.util.List<T>	dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<T> orderByComparator) Performs a dynamic query on the database and returns an ordered range of the matching rows.
static long	dynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) Returns the number of rows matching the dynamic query.
static long	dynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, com.liferay.portal.kernel.dao.orm.Projection projection) Returns the number of rows matching the dynamic query.
static SiteNavigationMenu	fetchPrimarySiteNavigationMenu(long groupId)
static SiteNavigationMenu	fetchSiteNavigationMenu(long siteNavigationMenuId)
static SiteNavigationMenu	fetchSiteNavigationMenu(long groupId, int type)
static SiteNavigationMenu	fetchSiteNavigationMenuByUuidAndGroupId(java.lang.String uuid, long groupId) Returns the site navigation menu matching the UUID and group.
static com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery	getActionableDynamicQuery()
static java.util.List<SiteNavigationMenu>	getAutoSiteNavigationMenus(long groupId)
static com.liferay.portal.kernel.dao.orm.ExportActionableDynamicQuery	getExportActionableDynamicQuery(com.liferay.exportimport.kernel.lar.PortletDataContext portletDataContext)
static com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery	getIndexableActionableDynamicQuery()
static java.lang.String	getOSGiServiceIdentifier() Returns the OSGi service identifier.
static com.liferay.portal.kernel.model.PersistedModel	getPersistedModel(java.io.Serializable primaryKeyObj)
static SiteNavigationMenuLocalService	getService()
static SiteNavigationMenu	getSiteNavigationMenu(long siteNavigationMenuId) Returns the site navigation menu with the primary key.
static SiteNavigationMenu	getSiteNavigationMenuByUuidAndGroupId(java.lang.String uuid, long groupId) Returns the site navigation menu matching the UUID and group.
static java.util.List<SiteNavigationMenu>	getSiteNavigationMenus(int start, int end) Returns a range of all the site navigation menus.
static java.util.List<SiteNavigationMenu>	getSiteNavigationMenus(long groupId)
static java.util.List<SiteNavigationMenu>	getSiteNavigationMenus(long groupId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<SiteNavigationMenu> orderByComparator)
static java.util.List<SiteNavigationMenu>	getSiteNavigationMenus(long groupId, java.lang.String keywords, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<SiteNavigationMenu> orderByComparator)
static java.util.List<SiteNavigationMenu>	getSiteNavigationMenusByUuidAndCompanyId(java.lang.String uuid, long companyId) Returns all the site navigation menus matching the UUID and company.
static java.util.List<SiteNavigationMenu>	getSiteNavigationMenusByUuidAndCompanyId(java.lang.String uuid, long companyId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<SiteNavigationMenu> orderByComparator) Returns a range of site navigation menus matching the UUID and company.
static int	getSiteNavigationMenusCount() Returns the number of site navigation menus.
static int	getSiteNavigationMenusCount(long groupId)
static int	getSiteNavigationMenusCount(long groupId, java.lang.String keywords)
static SiteNavigationMenu	updateSiteNavigationMenu(long userId, long siteNavigationMenuId, int type, boolean auto, com.liferay.portal.kernel.service.ServiceContext serviceContext)
static SiteNavigationMenu	updateSiteNavigationMenu(long userId, long siteNavigationMenuId, long groupId, java.lang.String name, int type, boolean auto)
static SiteNavigationMenu	updateSiteNavigationMenu(long userId, long siteNavigationMenuId, java.lang.String name, com.liferay.portal.kernel.service.ServiceContext serviceContext)
static SiteNavigationMenu	updateSiteNavigationMenu(SiteNavigationMenu siteNavigationMenu) Updates the site navigation menu 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

SiteNavigationMenuLocalServiceUtil

public SiteNavigationMenuLocalServiceUtil()

Method Detail

addSiteNavigationMenu

public static SiteNavigationMenu addSiteNavigationMenu(long userId,
                                                       long groupId,
                                                       java.lang.String name,
                                                       int type,
                                                       boolean auto,
                                                       com.liferay.portal.kernel.service.ServiceContext serviceContext)
                                                throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

addSiteNavigationMenu

public static SiteNavigationMenu addSiteNavigationMenu(long userId,
                                                       long groupId,
                                                       java.lang.String name,
                                                       int type,
                                                       com.liferay.portal.kernel.service.ServiceContext serviceContext)
                                                throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

addSiteNavigationMenu

public static SiteNavigationMenu addSiteNavigationMenu(long userId,
                                                       long groupId,
                                                       java.lang.String name,
                                                       com.liferay.portal.kernel.service.ServiceContext serviceContext)
                                                throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

addSiteNavigationMenu

public static SiteNavigationMenu addSiteNavigationMenu(SiteNavigationMenu siteNavigationMenu)

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

Important: Inspect SiteNavigationMenuLocalServiceImpl 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:

siteNavigationMenu - the site navigation menu

Returns:

the site navigation menu that was added

createPersistedModel

public static com.liferay.portal.kernel.model.PersistedModel createPersistedModel(java.io.Serializable primaryKeyObj)
                                                                           throws com.liferay.portal.kernel.exception.PortalException

Throws:

PortalException

createSiteNavigationMenu

public static SiteNavigationMenu createSiteNavigationMenu(long siteNavigationMenuId)

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

Parameters:

siteNavigationMenuId - the primary key for the new site navigation menu

Returns:

the new site navigation menu

deletePersistedModel

public static com.liferay.portal.kernel.model.PersistedModel deletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel)
                                                                           throws com.liferay.portal.kernel.exception.PortalException

Throws:

PortalException

deleteSiteNavigationMenu

public static SiteNavigationMenu deleteSiteNavigationMenu(long siteNavigationMenuId)
                                                   throws com.liferay.portal.kernel.exception.PortalException

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

Important: Inspect SiteNavigationMenuLocalServiceImpl 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:

siteNavigationMenuId - the primary key of the site navigation menu

Returns:

the site navigation menu that was removed

Throws:

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

deleteSiteNavigationMenu

public static SiteNavigationMenu deleteSiteNavigationMenu(SiteNavigationMenu siteNavigationMenu)
                                                   throws com.liferay.portal.kernel.exception.PortalException

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

Important: Inspect SiteNavigationMenuLocalServiceImpl 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:

siteNavigationMenu - the site navigation menu

Returns:

the site navigation menu that was removed

Throws:

PortalException

deleteSiteNavigationMenus

public static void deleteSiteNavigationMenus(long groupId)

dslQuery

public static <T> T dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)

dynamicQuery

public static com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery()

dynamicQuery

public static <T> java.util.List<T> dynamicQuery(com.liferay.portal.kernel.dao.orm.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> java.util.List<T> dynamicQuery(com.liferay.portal.kernel.dao.orm.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.SiteNavigationMenuModelImpl.

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> java.util.List<T> dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery,
                                                 int start,
                                                 int end,
                                                 com.liferay.portal.kernel.util.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.SiteNavigationMenuModelImpl.

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(com.liferay.portal.kernel.dao.orm.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(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery,
                                     com.liferay.portal.kernel.dao.orm.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

fetchPrimarySiteNavigationMenu

public static SiteNavigationMenu fetchPrimarySiteNavigationMenu(long groupId)

fetchSiteNavigationMenu

public static SiteNavigationMenu fetchSiteNavigationMenu(long siteNavigationMenuId)

fetchSiteNavigationMenu

public static SiteNavigationMenu fetchSiteNavigationMenu(long groupId,
                                                         int type)

fetchSiteNavigationMenuByUuidAndGroupId

public static SiteNavigationMenu fetchSiteNavigationMenuByUuidAndGroupId(java.lang.String uuid,
                                                                         long groupId)

Returns the site navigation menu matching the UUID and group.

Parameters:

uuid - the site navigation menu's UUID

groupId - the primary key of the group

Returns:

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

getActionableDynamicQuery

public static com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery()

getAutoSiteNavigationMenus

public static java.util.List<SiteNavigationMenu> getAutoSiteNavigationMenus(long groupId)

getExportActionableDynamicQuery

public static com.liferay.portal.kernel.dao.orm.ExportActionableDynamicQuery getExportActionableDynamicQuery(com.liferay.exportimport.kernel.lar.PortletDataContext portletDataContext)

getIndexableActionableDynamicQuery

public static com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()

getOSGiServiceIdentifier

public static java.lang.String getOSGiServiceIdentifier()

Returns the OSGi service identifier.

Returns:

the OSGi service identifier

getPersistedModel

public static com.liferay.portal.kernel.model.PersistedModel getPersistedModel(java.io.Serializable primaryKeyObj)
                                                                        throws com.liferay.portal.kernel.exception.PortalException

Throws:

PortalException

getSiteNavigationMenu

public static SiteNavigationMenu getSiteNavigationMenu(long siteNavigationMenuId)
                                                throws com.liferay.portal.kernel.exception.PortalException

Returns the site navigation menu with the primary key.

Parameters:

siteNavigationMenuId - the primary key of the site navigation menu

Returns:

the site navigation menu

Throws:

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

getSiteNavigationMenuByUuidAndGroupId

public static SiteNavigationMenu getSiteNavigationMenuByUuidAndGroupId(java.lang.String uuid,
                                                                       long groupId)
                                                                throws com.liferay.portal.kernel.exception.PortalException

Returns the site navigation menu matching the UUID and group.

Parameters:

uuid - the site navigation menu's UUID

groupId - the primary key of the group

Returns:

the matching site navigation menu

Throws:

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

getSiteNavigationMenus

public static java.util.List<SiteNavigationMenu> getSiteNavigationMenus(int start,
                                                                        int end)

Returns a range of all the site navigation menus.

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

Parameters:

start - the lower bound of the range of site navigation menus

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

Returns:

the range of site navigation menus

getSiteNavigationMenus

public static java.util.List<SiteNavigationMenu> getSiteNavigationMenus(long groupId)

getSiteNavigationMenus

public static java.util.List<SiteNavigationMenu> getSiteNavigationMenus(long groupId,
                                                                        int start,
                                                                        int end,
                                                                        com.liferay.portal.kernel.util.OrderByComparator<SiteNavigationMenu> orderByComparator)

getSiteNavigationMenus

public static java.util.List<SiteNavigationMenu> getSiteNavigationMenus(long groupId,
                                                                        java.lang.String keywords,
                                                                        int start,
                                                                        int end,
                                                                        com.liferay.portal.kernel.util.OrderByComparator<SiteNavigationMenu> orderByComparator)

getSiteNavigationMenusByUuidAndCompanyId

public static java.util.List<SiteNavigationMenu> getSiteNavigationMenusByUuidAndCompanyId(java.lang.String uuid,
                                                                                          long companyId)

Returns all the site navigation menus matching the UUID and company.

Parameters:

uuid - the UUID of the site navigation menus

companyId - the primary key of the company

Returns:

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

getSiteNavigationMenusByUuidAndCompanyId

public static java.util.List<SiteNavigationMenu> getSiteNavigationMenusByUuidAndCompanyId(java.lang.String uuid,
                                                                                          long companyId,
                                                                                          int start,
                                                                                          int end,
                                                                                          com.liferay.portal.kernel.util.OrderByComparator<SiteNavigationMenu> orderByComparator)

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

Parameters:

uuid - the UUID of the site navigation menus

companyId - the primary key of the company

start - the lower bound of the range of site navigation menus

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

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

Returns:

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

getSiteNavigationMenusCount

public static int getSiteNavigationMenusCount()

Returns the number of site navigation menus.

Returns:

the number of site navigation menus

getSiteNavigationMenusCount

public static int getSiteNavigationMenusCount(long groupId)

getSiteNavigationMenusCount

public static int getSiteNavigationMenusCount(long groupId,
                                              java.lang.String keywords)

updateSiteNavigationMenu

public static SiteNavigationMenu updateSiteNavigationMenu(long userId,
                                                          long siteNavigationMenuId,
                                                          int type,
                                                          boolean auto,
                                                          com.liferay.portal.kernel.service.ServiceContext serviceContext)
                                                   throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

updateSiteNavigationMenu

public static SiteNavigationMenu updateSiteNavigationMenu(long userId,
                                                          long siteNavigationMenuId,
                                                          long groupId,
                                                          java.lang.String name,
                                                          int type,
                                                          boolean auto)
                                                   throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

updateSiteNavigationMenu

public static SiteNavigationMenu updateSiteNavigationMenu(long userId,
                                                          long siteNavigationMenuId,
                                                          java.lang.String name,
                                                          com.liferay.portal.kernel.service.ServiceContext serviceContext)
                                                   throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

updateSiteNavigationMenu

public static SiteNavigationMenu updateSiteNavigationMenu(SiteNavigationMenu siteNavigationMenu)

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

Important: Inspect SiteNavigationMenuLocalServiceImpl 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:

siteNavigationMenu - the site navigation menu

Returns:

the site navigation menu that was updated

getService

public static SiteNavigationMenuLocalService getService()