Interface SiteNavigationMenuLocalService

All Superinterfaces:
com.liferay.portal.kernel.service.BaseLocalService, com.liferay.portal.kernel.service.change.tracking.CTService<SiteNavigationMenu>, com.liferay.portal.kernel.service.PersistedModelLocalService
All Known Implementing Classes:
SiteNavigationMenuLocalServiceWrapper

@CTAware @ProviderType @Transactional(isolation=PORTAL, rollbackFor={com.liferay.portal.kernel.exception.PortalException.class,com.liferay.portal.kernel.exception.SystemException.class}) public interface SiteNavigationMenuLocalService extends com.liferay.portal.kernel.service.BaseLocalService, com.liferay.portal.kernel.service.change.tracking.CTService<SiteNavigationMenu>, com.liferay.portal.kernel.service.PersistedModelLocalService
Provides the local service interface for SiteNavigationMenu. 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:
  • Method Details

    • addSiteNavigationMenu

      @Indexable(type=REINDEX) 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
    • addSiteNavigationMenu

      SiteNavigationMenu addSiteNavigationMenu(String externalReferenceCode, long userId, long groupId, 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

      SiteNavigationMenu addSiteNavigationMenu(String externalReferenceCode, long userId, long groupId, 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

      SiteNavigationMenu addSiteNavigationMenu(String externalReferenceCode, long userId, long groupId, String name, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • createPersistedModel

      com.liferay.portal.kernel.model.PersistedModel createPersistedModel(Serializable primaryKeyObj) throws com.liferay.portal.kernel.exception.PortalException
      Specified by:
      createPersistedModel in interface com.liferay.portal.kernel.service.PersistedModelLocalService
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • createSiteNavigationMenu

      @Transactional(enabled=false) 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

      com.liferay.portal.kernel.model.PersistedModel deletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel) throws com.liferay.portal.kernel.exception.PortalException
      Specified by:
      deletePersistedModel in interface com.liferay.portal.kernel.service.PersistedModelLocalService
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • deleteSiteNavigationMenu

      @Indexable(type=DELETE) 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:
      com.liferay.portal.kernel.exception.PortalException - if a site navigation menu with the primary key could not be found
    • deleteSiteNavigationMenu

      @Indexable(type=DELETE) @SystemEvent(type=1) 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:
      com.liferay.portal.kernel.exception.PortalException
    • deleteSiteNavigationMenu

      SiteNavigationMenu deleteSiteNavigationMenu(String externalReferenceCode, long groupId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • deleteSiteNavigationMenus

      void deleteSiteNavigationMenus(long groupId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • dslQuery

      @Transactional(propagation=SUPPORTS, readOnly=true) <T> T dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)
      Specified by:
      dslQuery in interface com.liferay.portal.kernel.service.PersistedModelLocalService
    • dslQueryCount

      @Transactional(propagation=SUPPORTS, readOnly=true) int dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)
      Specified by:
      dslQueryCount in interface com.liferay.portal.kernel.service.PersistedModelLocalService
    • dynamicQuery

      @Transactional(propagation=SUPPORTS, readOnly=true) com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery()
    • dynamicQuery

      @Transactional(propagation=SUPPORTS, readOnly=true) <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

      @Transactional(propagation=SUPPORTS, readOnly=true) <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.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

      @Transactional(propagation=SUPPORTS, readOnly=true) <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.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

      @Transactional(propagation=SUPPORTS, readOnly=true) 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

      @Transactional(propagation=SUPPORTS, readOnly=true) 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

      @Transactional(propagation=SUPPORTS, readOnly=true) SiteNavigationMenu fetchPrimarySiteNavigationMenu(long groupId)
    • fetchSiteNavigationMenu

      @Transactional(propagation=SUPPORTS, readOnly=true) SiteNavigationMenu fetchSiteNavigationMenu(long siteNavigationMenuId)
    • fetchSiteNavigationMenu

      @Transactional(propagation=SUPPORTS, readOnly=true) SiteNavigationMenu fetchSiteNavigationMenu(long groupId, int type)
    • fetchSiteNavigationMenuByExternalReferenceCode

      @Transactional(propagation=SUPPORTS, readOnly=true) SiteNavigationMenu fetchSiteNavigationMenuByExternalReferenceCode(String externalReferenceCode, long groupId)
    • fetchSiteNavigationMenuByName

      @Transactional(propagation=SUPPORTS, readOnly=true) SiteNavigationMenu fetchSiteNavigationMenuByName(long groupId, String name)
    • fetchSiteNavigationMenuByUuidAndGroupId

      @Transactional(propagation=SUPPORTS, readOnly=true) SiteNavigationMenu fetchSiteNavigationMenuByUuidAndGroupId(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

      @Transactional(propagation=SUPPORTS, readOnly=true) com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery()
    • getAutoSiteNavigationMenus

      @Transactional(propagation=SUPPORTS, readOnly=true) List<SiteNavigationMenu> getAutoSiteNavigationMenus(long groupId)
    • getExportActionableDynamicQuery

      @Transactional(propagation=SUPPORTS, readOnly=true) com.liferay.portal.kernel.dao.orm.ExportActionableDynamicQuery getExportActionableDynamicQuery(com.liferay.exportimport.kernel.lar.PortletDataContext portletDataContext)
    • getIndexableActionableDynamicQuery

      @Transactional(propagation=SUPPORTS, readOnly=true) com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()
    • getOSGiServiceIdentifier

      String getOSGiServiceIdentifier()
      Returns the OSGi service identifier.
      Returns:
      the OSGi service identifier
    • getPersistedModel

      @Transactional(propagation=SUPPORTS, readOnly=true) com.liferay.portal.kernel.model.PersistedModel getPersistedModel(Serializable primaryKeyObj) throws com.liferay.portal.kernel.exception.PortalException
      Specified by:
      getPersistedModel in interface com.liferay.portal.kernel.service.PersistedModelLocalService
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getSiteNavigationMenu

      @Transactional(propagation=SUPPORTS, readOnly=true) 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:
      com.liferay.portal.kernel.exception.PortalException - if a site navigation menu with the primary key could not be found
    • getSiteNavigationMenuByExternalReferenceCode

      @Transactional(propagation=SUPPORTS, readOnly=true) SiteNavigationMenu getSiteNavigationMenuByExternalReferenceCode(String externalReferenceCode, long groupId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getSiteNavigationMenuByUuidAndGroupId

      @Transactional(propagation=SUPPORTS, readOnly=true) SiteNavigationMenu getSiteNavigationMenuByUuidAndGroupId(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:
      com.liferay.portal.kernel.exception.PortalException - if a matching site navigation menu could not be found
    • getSiteNavigationMenus

      @Transactional(propagation=SUPPORTS, readOnly=true) 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

      @Transactional(propagation=SUPPORTS, readOnly=true) List<SiteNavigationMenu> getSiteNavigationMenus(long groupId)
    • getSiteNavigationMenus

      @Transactional(propagation=SUPPORTS, readOnly=true) List<SiteNavigationMenu> getSiteNavigationMenus(long groupId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<SiteNavigationMenu> orderByComparator)
    • getSiteNavigationMenus

      @Transactional(propagation=SUPPORTS, readOnly=true) List<SiteNavigationMenu> getSiteNavigationMenus(long groupId, String keywords, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<SiteNavigationMenu> orderByComparator)
    • getSiteNavigationMenusByUuidAndCompanyId

      @Transactional(propagation=SUPPORTS, readOnly=true) List<SiteNavigationMenu> getSiteNavigationMenusByUuidAndCompanyId(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

      @Transactional(propagation=SUPPORTS, readOnly=true) List<SiteNavigationMenu> getSiteNavigationMenusByUuidAndCompanyId(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

      @Transactional(propagation=SUPPORTS, readOnly=true) int getSiteNavigationMenusCount()
      Returns the number of site navigation menus.
      Returns:
      the number of site navigation menus
    • getSiteNavigationMenusCount

      @Transactional(propagation=SUPPORTS, readOnly=true) int getSiteNavigationMenusCount(long groupId)
    • getSiteNavigationMenusCount

      @Transactional(propagation=SUPPORTS, readOnly=true) int getSiteNavigationMenusCount(long groupId, String keywords)
    • updateSiteNavigationMenu

      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

      SiteNavigationMenu updateSiteNavigationMenu(long userId, long siteNavigationMenuId, long groupId, String name, int type, boolean auto) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • updateSiteNavigationMenu

      SiteNavigationMenu updateSiteNavigationMenu(long userId, long siteNavigationMenuId, String name, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • updateSiteNavigationMenu

      @Indexable(type=REINDEX) 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
    • getCTPersistence

      @Transactional(enabled=false) com.liferay.portal.kernel.service.persistence.change.tracking.CTPersistence<SiteNavigationMenu> getCTPersistence()
      Specified by:
      getCTPersistence in interface com.liferay.portal.kernel.service.change.tracking.CTService<SiteNavigationMenu>
    • getModelClass

      @Transactional(enabled=false) Class<SiteNavigationMenu> getModelClass()
      Specified by:
      getModelClass in interface com.liferay.portal.kernel.service.change.tracking.CTService<SiteNavigationMenu>
    • updateWithUnsafeFunction

      @Transactional(rollbackFor=java.lang.Throwable.class) <R, E extends Throwable> R updateWithUnsafeFunction(com.liferay.petra.function.UnsafeFunction<com.liferay.portal.kernel.service.persistence.change.tracking.CTPersistence<SiteNavigationMenu>,R,E> updateUnsafeFunction) throws E
      Specified by:
      updateWithUnsafeFunction in interface com.liferay.portal.kernel.service.change.tracking.CTService<SiteNavigationMenu>
      Throws:
      E extends Throwable