Interface KBFolderLocalService

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

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

    • addKBFolder

      @Indexable(type=REINDEX) KBFolder addKBFolder(KBFolder kbFolder)
      Adds the kb folder to the database. Also notifies the appropriate model listeners.

      Important: Inspect KBFolderLocalServiceImpl 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:
      kbFolder - the kb folder
      Returns:
      the kb folder that was added
    • addKBFolder

      KBFolder addKBFolder(String externalReferenceCode, long userId, long groupId, long parentResourceClassNameId, long parentResourcePrimKey, String name, String description, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • createKBFolder

      @Transactional(enabled=false) KBFolder createKBFolder(long kbFolderId)
      Creates a new kb folder with the primary key. Does not add the kb folder to the database.
      Parameters:
      kbFolderId - the primary key for the new kb folder
      Returns:
      the new kb folder
    • 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
    • deleteKBFolder

      @Indexable(type=DELETE) KBFolder deleteKBFolder(KBFolder kbFolder) throws com.liferay.portal.kernel.exception.PortalException
      Deletes the kb folder from the database. Also notifies the appropriate model listeners.

      Important: Inspect KBFolderLocalServiceImpl 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:
      kbFolder - the kb folder
      Returns:
      the kb folder that was removed
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • deleteKBFolder

      @SystemEvent(action=1, type=1) KBFolder deleteKBFolder(KBFolder kbFolder, boolean includeTrashedEntries) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • deleteKBFolder

      @Indexable(type=DELETE) KBFolder deleteKBFolder(long kbFolderId) throws com.liferay.portal.kernel.exception.PortalException
      Deletes the kb folder with the primary key from the database. Also notifies the appropriate model listeners.

      Important: Inspect KBFolderLocalServiceImpl 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:
      kbFolderId - the primary key of the kb folder
      Returns:
      the kb folder that was removed
      Throws:
      com.liferay.portal.kernel.exception.PortalException - if a kb folder with the primary key could not be found
    • deleteKBFolder

      KBFolder deleteKBFolder(long kbFolderId, boolean includeTrashedEntries) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • deleteKBFolders

      void deleteKBFolders(long groupId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • 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
    • 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.knowledge.base.model.impl.KBFolderModelImpl.

      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.knowledge.base.model.impl.KBFolderModelImpl.

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

      @Transactional(propagation=SUPPORTS, readOnly=true) KBFolder fetchFirstChildKBFolder(long groupId, long kbFolderId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • fetchFirstChildKBFolder

      @Transactional(propagation=SUPPORTS, readOnly=true) KBFolder fetchFirstChildKBFolder(long groupId, long kbFolderId, com.liferay.portal.kernel.util.OrderByComparator<KBFolder> orderByComparator) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • fetchKBFolder

      @Transactional(propagation=SUPPORTS, readOnly=true) KBFolder fetchKBFolder(long kbFolderId)
    • fetchKBFolder

      @Transactional(propagation=SUPPORTS, readOnly=true) KBFolder fetchKBFolder(String uuid, long groupId)
    • fetchKBFolderByExternalReferenceCode

      @Transactional(propagation=SUPPORTS, readOnly=true) KBFolder fetchKBFolderByExternalReferenceCode(String externalReferenceCode, long groupId)
    • fetchKBFolderByUrlTitle

      @Transactional(propagation=SUPPORTS, readOnly=true) KBFolder fetchKBFolderByUrlTitle(long groupId, long parentKbFolderId, String urlTitle) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • fetchKBFolderByUuidAndGroupId

      @Transactional(propagation=SUPPORTS, readOnly=true) KBFolder fetchKBFolderByUuidAndGroupId(String uuid, long groupId)
      Returns the kb folder matching the UUID and group.
      Parameters:
      uuid - the kb folder's UUID
      groupId - the primary key of the group
      Returns:
      the matching kb folder, or null if a matching kb folder 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()
    • getKBFolder

      @Transactional(propagation=SUPPORTS, readOnly=true) KBFolder getKBFolder(long kbFolderId) throws com.liferay.portal.kernel.exception.PortalException
      Returns the kb folder with the primary key.
      Parameters:
      kbFolderId - the primary key of the kb folder
      Returns:
      the kb folder
      Throws:
      com.liferay.portal.kernel.exception.PortalException - if a kb folder with the primary key could not be found
    • getKBFolderByExternalReferenceCode

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

      @Transactional(propagation=SUPPORTS, readOnly=true) KBFolder getKBFolderByUrlTitle(long groupId, long parentKbFolderId, String urlTitle) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getKBFolderByUuidAndGroupId

      @Transactional(propagation=SUPPORTS, readOnly=true) KBFolder getKBFolderByUuidAndGroupId(String uuid, long groupId) throws com.liferay.portal.kernel.exception.PortalException
      Returns the kb folder matching the UUID and group.
      Parameters:
      uuid - the kb folder's UUID
      groupId - the primary key of the group
      Returns:
      the matching kb folder
      Throws:
      com.liferay.portal.kernel.exception.PortalException - if a matching kb folder could not be found
    • getKBFolders

      @Transactional(propagation=SUPPORTS, readOnly=true) List<KBFolder> getKBFolders(int start, int end)
      Returns a range of all the kb folders.

      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.knowledge.base.model.impl.KBFolderModelImpl.

      Parameters:
      start - the lower bound of the range of kb folders
      end - the upper bound of the range of kb folders (not inclusive)
      Returns:
      the range of kb folders
    • getKBFolders

      @Transactional(propagation=SUPPORTS, readOnly=true) List<KBFolder> getKBFolders(long groupId, long parentKBFolderId, int start, int end) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getKBFoldersAndKBArticles

      @Transactional(propagation=SUPPORTS, readOnly=true) List<Object> getKBFoldersAndKBArticles(long groupId, long parentResourcePrimKey)
    • getKBFoldersAndKBArticles

      @Transactional(propagation=SUPPORTS, readOnly=true) List<Object> getKBFoldersAndKBArticles(long groupId, long parentResourcePrimKey, int status)
    • getKBFoldersAndKBArticles

      @Transactional(propagation=SUPPORTS, readOnly=true) List<Object> getKBFoldersAndKBArticles(long groupId, long parentResourcePrimKey, int status, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<?> orderByComparator)
    • getKBFoldersAndKBArticlesCount

      @Transactional(propagation=SUPPORTS, readOnly=true) int getKBFoldersAndKBArticlesCount(long groupId, long parentResourcePrimKey, int status)
    • getKBFoldersByUuidAndCompanyId

      @Transactional(propagation=SUPPORTS, readOnly=true) List<KBFolder> getKBFoldersByUuidAndCompanyId(String uuid, long companyId)
      Returns all the kb folders matching the UUID and company.
      Parameters:
      uuid - the UUID of the kb folders
      companyId - the primary key of the company
      Returns:
      the matching kb folders, or an empty list if no matches were found
    • getKBFoldersByUuidAndCompanyId

      @Transactional(propagation=SUPPORTS, readOnly=true) List<KBFolder> getKBFoldersByUuidAndCompanyId(String uuid, long companyId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<KBFolder> orderByComparator)
      Returns a range of kb folders matching the UUID and company.
      Parameters:
      uuid - the UUID of the kb folders
      companyId - the primary key of the company
      start - the lower bound of the range of kb folders
      end - the upper bound of the range of kb folders (not inclusive)
      orderByComparator - the comparator to order the results by (optionally null)
      Returns:
      the range of matching kb folders, or an empty list if no matches were found
    • getKBFoldersCount

      @Transactional(propagation=SUPPORTS, readOnly=true) int getKBFoldersCount()
      Returns the number of kb folders.
      Returns:
      the number of kb folders
    • getKBFoldersCount

      @Transactional(propagation=SUPPORTS, readOnly=true) int getKBFoldersCount(long groupId, long parentKBFolderId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getKBFoldersCount

      @Transactional(propagation=SUPPORTS, readOnly=true) int getKBFoldersCount(long groupId, long parentKBFolderId, int status) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • 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
    • moveKBFolder

      KBFolder moveKBFolder(long kbFolderId, long parentKBFolderId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • moveKBFolderFromTrash

      KBFolder moveKBFolderFromTrash(long userId, long kbFolderId, long parentKBFolderId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • moveKBFolderToTrash

      KBFolder moveKBFolderToTrash(long userId, long kbFolderId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • restoreKBFolderFromTrash

      KBFolder restoreKBFolderFromTrash(long userId, long kbFolderId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • updateKBFolder

      @Indexable(type=REINDEX) KBFolder updateKBFolder(KBFolder kbFolder)
      Updates the kb folder in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

      Important: Inspect KBFolderLocalServiceImpl 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:
      kbFolder - the kb folder
      Returns:
      the kb folder that was updated
    • updateKBFolder

      KBFolder updateKBFolder(long parentResourceClassNameId, long parentResourcePrimKey, long kbFolderId, String name, String description, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • updateStatus

      KBFolder updateStatus(long userId, KBFolder kbFolder, int status) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getCTPersistence

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

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