Interface SiteNavigationMenuItemLocalService

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

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

    • addOrUpdateSiteNavigationMenuItem

      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

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

      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

      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

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

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

      @Indexable(type=DELETE) 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

      SiteNavigationMenuItem deleteSiteNavigationMenuItem(long siteNavigationMenuItemId, boolean deleteChildren) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • 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.

      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

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

      void deleteSiteNavigationMenuItems(long siteNavigationMenuId)
    • deleteSiteNavigationMenuItemsByGroupId

      void deleteSiteNavigationMenuItemsByGroupId(long groupId)
    • 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.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> 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

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

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

      @Transactional(propagation=SUPPORTS, readOnly=true) SiteNavigationMenuItem fetchSiteNavigationMenuItemByExternalReferenceCode(String externalReferenceCode, long groupId)
    • fetchSiteNavigationMenuItemByUuidAndGroupId

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

      @Transactional(propagation=SUPPORTS, readOnly=true) com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery()
    • 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
    • getParentSiteNavigationMenuItemIds

      @Transactional(propagation=SUPPORTS, readOnly=true) List<Long> getParentSiteNavigationMenuItemIds(long siteNavigationMenuId, String typeSettingsKeyword)
    • 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
    • getSiteNavigationMenuItem

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

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

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

      @Transactional(propagation=SUPPORTS, readOnly=true) 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) List<SiteNavigationMenuItem> getSiteNavigationMenuItems(long siteNavigationMenuId)
    • getSiteNavigationMenuItems

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

      @Transactional(propagation=SUPPORTS, readOnly=true) List<SiteNavigationMenuItem> getSiteNavigationMenuItems(long siteNavigationMenuId, com.liferay.portal.kernel.util.OrderByComparator<SiteNavigationMenuItem> orderByComparator)
    • getSiteNavigationMenuItemsByUuidAndCompanyId

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

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

      @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 com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • updateSiteNavigationMenuItem

      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

      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

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

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

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

      @Transactional(enabled=false) Class<SiteNavigationMenuItem> getModelClass()
      Specified by:
      getModelClass in interface com.liferay.portal.kernel.service.change.tracking.CTService<SiteNavigationMenuItem>
    • 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<SiteNavigationMenuItem>,R,E> updateUnsafeFunction) throws E
      Specified by:
      updateWithUnsafeFunction in interface com.liferay.portal.kernel.service.change.tracking.CTService<SiteNavigationMenuItem>
      Throws:
      E extends Throwable