Class SiteNavigationMenuItemLocalServiceUtil

java.lang.Object
com.liferay.site.navigation.service.SiteNavigationMenuItemLocalServiceUtil

public class SiteNavigationMenuItemLocalServiceUtil extends Object
Provides the local service utility for SiteNavigationMenuItem. This utility wraps com.liferay.site.navigation.service.impl.SiteNavigationMenuItemLocalServiceImpl 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:
Generated:
  • Constructor Details

    • SiteNavigationMenuItemLocalServiceUtil

      public SiteNavigationMenuItemLocalServiceUtil()
  • Method Details

    • addOrUpdateSiteNavigationMenuItem

      public static SiteNavigationMenuItem addOrUpdateSiteNavigationMenuItem(String externalReferenceCode, long userId, long groupId, long siteNavigationMenuId, long parentSiteNavigationMenuItemId, String type, String typeSettings, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws Exception
      Throws:
      Exception
    • addSiteNavigationMenuItem

      public static SiteNavigationMenuItem addSiteNavigationMenuItem(SiteNavigationMenuItem siteNavigationMenuItem)
      Adds the site navigation menu item to the database. Also notifies the appropriate model listeners.

      Important: Inspect SiteNavigationMenuItemLocalServiceImpl 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:
      siteNavigationMenuItem - the site navigation menu item
      Returns:
      the site navigation menu item that was added
    • addSiteNavigationMenuItem

      public static SiteNavigationMenuItem addSiteNavigationMenuItem(String externalReferenceCode, long userId, long groupId, long siteNavigationMenuId, long parentSiteNavigationMenuItemId, String type, int order, String typeSettings, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • addSiteNavigationMenuItem

      public static SiteNavigationMenuItem addSiteNavigationMenuItem(String externalReferenceCode, long userId, long groupId, long siteNavigationMenuId, long parentSiteNavigationMenuItemId, String type, String typeSettings, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • createPersistedModel

      public static com.liferay.portal.kernel.model.PersistedModel createPersistedModel(Serializable primaryKeyObj) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • createSiteNavigationMenuItem

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

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

      public static SiteNavigationMenuItem deleteSiteNavigationMenuItem(long siteNavigationMenuItemId) throws com.liferay.portal.kernel.exception.PortalException
      Deletes the site navigation menu item with the primary key from the database. Also notifies the appropriate model listeners.

      Important: Inspect SiteNavigationMenuItemLocalServiceImpl 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:
      siteNavigationMenuItemId - the primary key of the site navigation menu item
      Returns:
      the site navigation menu item that was removed
      Throws:
      com.liferay.portal.kernel.exception.PortalException - if a site navigation menu item with the primary key could not be found
    • deleteSiteNavigationMenuItem

      public static SiteNavigationMenuItem deleteSiteNavigationMenuItem(long siteNavigationMenuItemId, boolean deleteChildren) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • deleteSiteNavigationMenuItem

      public static SiteNavigationMenuItem deleteSiteNavigationMenuItem(SiteNavigationMenuItem siteNavigationMenuItem)
      Deletes the site navigation menu item from the database. Also notifies the appropriate model listeners.

      Important: Inspect SiteNavigationMenuItemLocalServiceImpl 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:
      siteNavigationMenuItem - the site navigation menu item
      Returns:
      the site navigation menu item that was removed
    • deleteSiteNavigationMenuItem

      public static SiteNavigationMenuItem deleteSiteNavigationMenuItem(String externalReferenceCode, long groupId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • deleteSiteNavigationMenuItems

      public static void deleteSiteNavigationMenuItems(long siteNavigationMenuId)
    • deleteSiteNavigationMenuItemsByGroupId

      public static void deleteSiteNavigationMenuItemsByGroupId(long groupId)
    • dslQuery

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

      public static int dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)
    • dynamicQuery

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

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

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

      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
    • fetchSiteNavigationMenuItem

      public static SiteNavigationMenuItem fetchSiteNavigationMenuItem(long siteNavigationMenuItemId)
    • fetchSiteNavigationMenuItemByExternalReferenceCode

      public static SiteNavigationMenuItem fetchSiteNavigationMenuItemByExternalReferenceCode(String externalReferenceCode, long groupId)
    • fetchSiteNavigationMenuItemByUuidAndGroupId

      public static SiteNavigationMenuItem fetchSiteNavigationMenuItemByUuidAndGroupId(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

      public static com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery()
    • 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 String getOSGiServiceIdentifier()
      Returns the OSGi service identifier.
      Returns:
      the OSGi service identifier
    • getParentSiteNavigationMenuItemIds

      public static List<Long> getParentSiteNavigationMenuItemIds(long siteNavigationMenuId, String typeSettingsKeyword)
    • getPersistedModel

      public static com.liferay.portal.kernel.model.PersistedModel getPersistedModel(Serializable primaryKeyObj) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getSiteNavigationMenuItem

      public static SiteNavigationMenuItem getSiteNavigationMenuItem(long siteNavigationMenuItemId) throws com.liferay.portal.kernel.exception.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:
      com.liferay.portal.kernel.exception.PortalException - if a site navigation menu item with the primary key could not be found
    • getSiteNavigationMenuItemByExternalReferenceCode

      public static SiteNavigationMenuItem getSiteNavigationMenuItemByExternalReferenceCode(String externalReferenceCode, long groupId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getSiteNavigationMenuItemByUuidAndGroupId

      public static SiteNavigationMenuItem getSiteNavigationMenuItemByUuidAndGroupId(String uuid, long groupId) throws com.liferay.portal.kernel.exception.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:
      com.liferay.portal.kernel.exception.PortalException - if a matching site navigation menu item could not be found
    • getSiteNavigationMenuItems

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

      public static List<SiteNavigationMenuItem> getSiteNavigationMenuItems(long siteNavigationMenuId)
    • getSiteNavigationMenuItems

      public static List<SiteNavigationMenuItem> getSiteNavigationMenuItems(long siteNavigationMenuId, long parentSiteNavigationMenuItemId)
    • getSiteNavigationMenuItems

      public static List<SiteNavigationMenuItem> getSiteNavigationMenuItems(long siteNavigationMenuId, com.liferay.portal.kernel.util.OrderByComparator<SiteNavigationMenuItem> orderByComparator)
    • getSiteNavigationMenuItemsByUuidAndCompanyId

      public static List<SiteNavigationMenuItem> getSiteNavigationMenuItemsByUuidAndCompanyId(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

      public static List<SiteNavigationMenuItem> getSiteNavigationMenuItemsByUuidAndCompanyId(String uuid, long companyId, int start, int end, com.liferay.portal.kernel.util.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

      public static int getSiteNavigationMenuItemsCount()
      Returns the number of site navigation menu items.
      Returns:
      the number of site navigation menu items
    • getSiteNavigationMenuItemsCount

      public static int getSiteNavigationMenuItemsCount(long siteNavigationMenuId)
    • updateSiteNavigationMenuItem

      public static SiteNavigationMenuItem updateSiteNavigationMenuItem(long siteNavigationMenuItemId, long parentSiteNavigationMenuItemId, int order) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • updateSiteNavigationMenuItem

      public static SiteNavigationMenuItem updateSiteNavigationMenuItem(long userId, long siteNavigationMenuItemId, long groupId, long siteNavigationMenuId, long parentSiteNavigationMenuItemId, String type, int order, String typeSettings) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • updateSiteNavigationMenuItem

      public static SiteNavigationMenuItem updateSiteNavigationMenuItem(long userId, long siteNavigationMenuItemId, String typeSettings, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • updateSiteNavigationMenuItem

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

      Important: Inspect SiteNavigationMenuItemLocalServiceImpl 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:
      siteNavigationMenuItem - the site navigation menu item
      Returns:
      the site navigation menu item that was updated
    • getService

      public static SiteNavigationMenuItemLocalService getService()