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
- See Also:
- Generated:
-
Method Summary
Modifier and TypeMethodDescriptionaddKBFolder
(KBFolder kbFolder) Adds the kb folder to the database.addKBFolder
(String externalReferenceCode, long userId, long groupId, long parentResourceClassNameId, long parentResourcePrimKey, String name, String description, com.liferay.portal.kernel.service.ServiceContext serviceContext) createKBFolder
(long kbFolderId) Creates a new kb folder with the primary key.com.liferay.portal.kernel.model.PersistedModel
createPersistedModel
(Serializable primaryKeyObj) deleteKBFolder
(long kbFolderId) Deletes the kb folder with the primary key from the database.deleteKBFolder
(long kbFolderId, boolean includeTrashedEntries) deleteKBFolder
(KBFolder kbFolder) Deletes the kb folder from the database.deleteKBFolder
(KBFolder kbFolder, boolean includeTrashedEntries) void
deleteKBFolders
(long groupId) com.liferay.portal.kernel.model.PersistedModel
deletePersistedModel
(com.liferay.portal.kernel.model.PersistedModel persistedModel) <T> T
dslQuery
(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) int
dslQueryCount
(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) com.liferay.portal.kernel.dao.orm.DynamicQuery
<T> List<T>
dynamicQuery
(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.<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.<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.long
dynamicQueryCount
(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) Returns the number of rows matching the dynamic query.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.fetchFirstChildKBFolder
(long groupId, long kbFolderId) fetchFirstChildKBFolder
(long groupId, long kbFolderId, com.liferay.portal.kernel.util.OrderByComparator<KBFolder> orderByComparator) fetchKBFolder
(long kbFolderId) fetchKBFolder
(String uuid, long groupId) fetchKBFolderByExternalReferenceCode
(String externalReferenceCode, long groupId) fetchKBFolderByUrlTitle
(long groupId, long parentKbFolderId, String urlTitle) fetchKBFolderByUuidAndGroupId
(String uuid, long groupId) Returns the kb folder matching the UUID and group.com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery
com.liferay.portal.kernel.service.persistence.change.tracking.CTPersistence<KBFolder>
com.liferay.portal.kernel.dao.orm.ExportActionableDynamicQuery
getExportActionableDynamicQuery
(com.liferay.exportimport.kernel.lar.PortletDataContext portletDataContext) com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery
getKBFolder
(long kbFolderId) Returns the kb folder with the primary key.getKBFolderByExternalReferenceCode
(String externalReferenceCode, long groupId) getKBFolderByUrlTitle
(long groupId, long parentKbFolderId, String urlTitle) getKBFolderByUuidAndGroupId
(String uuid, long groupId) Returns the kb folder matching the UUID and group.getKBFolders
(int start, int end) Returns a range of all the kb folders.getKBFolders
(long groupId, long parentKBFolderId, int start, int end) getKBFoldersAndKBArticles
(long groupId, long parentResourcePrimKey) getKBFoldersAndKBArticles
(long groupId, long parentResourcePrimKey, int status) getKBFoldersAndKBArticles
(long groupId, long parentResourcePrimKey, int status, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<?> orderByComparator) int
getKBFoldersAndKBArticlesCount
(long groupId, long parentResourcePrimKey, int status) getKBFoldersByUuidAndCompanyId
(String uuid, long companyId) Returns all the kb folders matching the UUID and company.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.int
Returns the number of kb folders.int
getKBFoldersCount
(long groupId, long parentKBFolderId) int
getKBFoldersCount
(long groupId, long parentKBFolderId, int status) Returns the OSGi service identifier.com.liferay.portal.kernel.model.PersistedModel
getPersistedModel
(Serializable primaryKeyObj) moveKBFolder
(long kbFolderId, long parentKBFolderId) moveKBFolderFromTrash
(long userId, long kbFolderId, long parentKBFolderId) moveKBFolderToTrash
(long userId, long kbFolderId) restoreKBFolderFromTrash
(long userId, long kbFolderId) updateKBFolder
(long parentResourceClassNameId, long parentResourcePrimKey, long kbFolderId, String name, String description, com.liferay.portal.kernel.service.ServiceContext serviceContext) updateKBFolder
(KBFolder kbFolder) Updates the kb folder in the database or adds it if it does not yet exist.updateStatus
(long userId, KBFolder kbFolder, int status) <R,
E extends Throwable>
RupdateWithUnsafeFunction
(com.liferay.petra.function.UnsafeFunction<com.liferay.portal.kernel.service.persistence.change.tracking.CTPersistence<KBFolder>, R, E> updateUnsafeFunction) Methods inherited from interface com.liferay.portal.kernel.service.PersistedModelLocalService
fetchPersistedModel, getBasePersistence
-
Method Details
-
addKBFolder
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
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 interfacecom.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 interfacecom.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 interfacecom.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 interfacecom.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
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
tocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS
will return the full result set. IforderByComparator
is specified, then the query will include the given ORDER BY logic. IforderByComparator
is absent, then the query will include the default ORDER BY logic fromcom.liferay.knowledge.base.model.impl.KBFolderModelImpl
.- Parameters:
dynamicQuery
- the dynamic querystart
- the lower bound of the range of model instancesend
- 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
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
tocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS
will return the full result set. IforderByComparator
is specified, then the query will include the given ORDER BY logic. IforderByComparator
is absent, then the query will include the default ORDER BY logic fromcom.liferay.knowledge.base.model.impl.KBFolderModelImpl
.- Parameters:
dynamicQuery
- the dynamic querystart
- the lower bound of the range of model instancesend
- the upper bound of the range of model instances (not inclusive)orderByComparator
- the comparator to order the results by (optionallynull
)- 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 queryprojection
- 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
-
fetchKBFolder
-
fetchKBFolderByExternalReferenceCode
-
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 UUIDgroupId
- 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 UUIDgroupId
- 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
Returns a range of all the kb folders.Useful when paginating results. Returns a maximum of
end - start
instances.start
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
tocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS
will return the full result set. IforderByComparator
is specified, then the query will include the given ORDER BY logic. IforderByComparator
is absent, then the query will include the default ORDER BY logic fromcom.liferay.knowledge.base.model.impl.KBFolderModelImpl
.- Parameters:
start
- the lower bound of the range of kb foldersend
- 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
-
getKBFoldersAndKBArticles
-
getKBFoldersAndKBArticles
-
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 folderscompanyId
- 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 folderscompanyId
- the primary key of the companystart
- the lower bound of the range of kb foldersend
- the upper bound of the range of kb folders (not inclusive)orderByComparator
- the comparator to order the results by (optionallynull
)- 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 interfacecom.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
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 interfacecom.liferay.portal.kernel.service.change.tracking.CTService<KBFolder>
-
getModelClass
- Specified by:
getModelClass
in interfacecom.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, throws EE> updateUnsafeFunction)
-