Class KBArticleLocalServiceWrapper
- All Implemented Interfaces:
KBArticleLocalService,com.liferay.portal.kernel.service.BaseLocalService,com.liferay.portal.kernel.service.change.tracking.CTService<KBArticle>,com.liferay.portal.kernel.service.PersistedModelLocalService,com.liferay.portal.kernel.service.PersistedResourcedModelLocalService,com.liferay.portal.kernel.service.ServiceWrapper<KBArticleLocalService>
KBArticleLocalService.- See Also:
- Generated:
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptioncom.liferay.portal.kernel.repository.model.FileEntryaddAttachment(long userId, long resourcePrimKey, String fileName, InputStream inputStream, String mimeType) addKBArticle(KBArticle kbArticle) Adds the kb article to the database.addKBArticle(String externalReferenceCode, long userId, long parentResourceClassNameId, long parentResourcePrimKey, String title, String urlTitle, String content, String description, String[] sections, String sourceURL, Date displayDate, Date expirationDate, Date reviewDate, String[] selectedFileNames, com.liferay.portal.kernel.service.ServiceContext serviceContext) voidaddKBArticleResources(long kbArticleId, boolean addGroupPermissions, boolean addGuestPermissions) voidaddKBArticleResources(KBArticle kbArticle, boolean addGroupPermissions, boolean addGuestPermissions) voidaddKBArticleResources(KBArticle kbArticle, com.liferay.portal.kernel.service.permission.ModelPermissions modelPermissions) intaddKBArticlesMarkdown(long userId, long groupId, long parentKbFolderId, String fileName, boolean prioritizeByNumericalPrefix, InputStream inputStream, com.liferay.portal.kernel.service.ServiceContext serviceContext) voidaddTempAttachment(long groupId, long userId, String fileName, String tempFolderName, InputStream inputStream, String mimeType) voidcheckKBArticles(long companyId) createKBArticle(long kbArticleId) Creates a new kb article with the primary key.com.liferay.portal.kernel.model.PersistedModelcreatePersistedModel(Serializable primaryKeyObj) voiddeleteGroupKBArticles(long groupId) deleteKBArticle(long kbArticleId) Deletes the kb article with the primary key from the database.deleteKBArticle(long userId, long resourcePrimKey, int version) deleteKBArticle(KBArticle kbArticle) Deletes the kb article from the database.voiddeleteKBArticles(long[] resourcePrimKeys) voiddeleteKBArticles(long groupId, long parentResourcePrimKey) voiddeleteKBArticles(long groupId, long parentResourcePrimKey, boolean includeTrashedEntries) com.liferay.portal.kernel.model.PersistedModeldeletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel) voiddeleteTempAttachment(long groupId, long userId, String fileName, String tempFolderName) <T> TdslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) intdslQueryCount(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.longdynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) Returns the number of rows matching the dynamic query.longdynamicQueryCount(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.expireKBArticle(long userId, long resourcePrimKey, com.liferay.portal.kernel.service.ServiceContext serviceContext) fetchFirstChildKBArticle(long groupId, long parentResourcePrimKey) fetchKBArticle(long kbArticleId) fetchKBArticle(long resourcePrimKey, long groupId, int version) fetchKBArticleByUrlTitle(long groupId, long kbFolderId, String urlTitle) fetchKBArticleByUrlTitle(long groupId, String kbFolderUrlTitle, String urlTitle) fetchKBArticleByUuidAndGroupId(String uuid, long groupId) Returns the kb article matching the UUID and group.fetchLatestKBArticle(long resourcePrimKey, int status) fetchLatestKBArticle(long resourcePrimKey, long groupId) fetchLatestKBArticleByExternalReferenceCode(long groupId, String externalReferenceCode) fetchLatestKBArticleByUrlTitle(long groupId, long kbFolderId, String urlTitle, int status) com.liferay.portal.kernel.model.PersistedModelfetchPersistedModel(Serializable primaryKeyObj) com.liferay.portal.kernel.dao.orm.ActionableDynamicQuerygetAllDescendantKBArticles(long resourcePrimKey, int status, com.liferay.portal.kernel.util.OrderByComparator<KBArticle> orderByComparator) com.liferay.portal.kernel.service.persistence.BasePersistence<?>getCompanyKBArticles(long companyId, int status, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<KBArticle> orderByComparator) intgetCompanyKBArticlesCount(long companyId, int status) com.liferay.portal.kernel.service.persistence.change.tracking.CTPersistence<KBArticle>com.liferay.portal.kernel.dao.orm.ExportActionableDynamicQuerygetExportActionableDynamicQuery(com.liferay.exportimport.kernel.lar.PortletDataContext portletDataContext) getGroupKBArticles(long groupId, int status, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<KBArticle> orderByComparator) intgetGroupKBArticlesCount(long groupId, int status) com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuerygetKBArticle(long kbArticleId) Returns the kb article with the primary key.getKBArticle(long resourcePrimKey, int version) getKBArticleAndAllDescendantKBArticles(long resourcePrimKey, int status, com.liferay.portal.kernel.util.OrderByComparator<KBArticle> orderByComparator) getKBArticleByUrlTitle(long groupId, long kbFolderId, String urlTitle) getKBArticleByUrlTitle(long groupId, String kbFolderUrlTitle, String urlTitle) getKBArticleByUuidAndGroupId(String uuid, long groupId) Returns the kb article matching the UUID and group.getKBArticles(int start, int end) Returns a range of all the kb articles.getKBArticles(long[] resourcePrimKeys, int status, com.liferay.portal.kernel.util.OrderByComparator<KBArticle> orderByComparator) getKBArticles(long groupId, long parentResourcePrimKey, int status, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<KBArticle> orderByComparator) getKBArticlesByUuidAndCompanyId(String uuid, long companyId) Returns all the kb articles matching the UUID and company.getKBArticlesByUuidAndCompanyId(String uuid, long companyId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<KBArticle> orderByComparator) Returns a range of kb articles matching the UUID and company.intReturns the number of kb articles.intgetKBArticlesCount(long groupId, long parentResourcePrimKey, int status) getKBArticleVersions(long resourcePrimKey, int status, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<KBArticle> orderByComparator) intgetKBArticleVersionsCount(long resourcePrimKey, int status) getKBFolderKBArticles(long groupId, long kbFolderId) intgetKBFolderKBArticlesCount(long groupId, long kbFolderId, int status) getLatestKBArticle(long resourcePrimKey) getLatestKBArticle(long resourcePrimKey, int status) getLatestKBArticle(long resourcePrimKey, int[] statuses) getLatestKBArticleByExternalReferenceCode(long groupId, String externalReferenceCode) getLatestKBArticleByUrlTitle(long groupId, long kbFolderId, String urlTitle, int status) Returns the OSGi service identifier.List<? extends com.liferay.portal.kernel.model.PersistedModel>getPersistedModel(long resourcePrimKey) com.liferay.portal.kernel.model.PersistedModelgetPersistedModel(Serializable primaryKeyObj) getPreviousAndNextKBArticles(long kbArticleId) getSectionsKBArticles(long groupId, String[] sections, int status, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<KBArticle> orderByComparator) intgetSectionsKBArticlesCount(long groupId, String[] sections, int status) String[]getTempAttachmentNames(long groupId, long userId, String tempFolderName) booleanhasKBArticleLock(long userId, long resourcePrimKey) voidincrementViewCount(long userId, long resourcePrimKey, int increment) com.liferay.portal.kernel.lock.LocklockKBArticle(long userId, long resourcePrimKey) voidmoveDependentKBArticlesToTrash(long parentResourcePrimKey, long trashEntryId) voidmoveDependentKBArticleToTrash(KBArticle kbArticle, long trashEntryId) voidmoveKBArticle(long userId, long resourcePrimKey, long parentResourceClassNameId, long parentResourcePrimKey, double priority) voidmoveKBArticleFromTrash(long userId, long resourcePrimKey, long parentResourceClassNameId, long parentResourcePrimKey) moveKBArticleToTrash(long userId, long resourcePrimKey) voidrestoreDependentKBArticleFromTrash(KBArticle kbArticle) voidrestoreDependentKBArticlesFromTrash(long parentResourcePrimKey) voidrestoreKBArticleFromTrash(long userId, long resourcePrimKey) revertKBArticle(long userId, long resourcePrimKey, int version, com.liferay.portal.kernel.service.ServiceContext serviceContext) search(long groupId, String title, String content, int status, Date startDate, Date endDate, boolean andOperator, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<KBArticle> orderByComparator) voidsetWrappedService(KBArticleLocalService kbArticleLocalService) voidsubscribeGroupKBArticles(long userId, long groupId) voidsubscribeKBArticle(long userId, long groupId, long resourcePrimKey) voidunlockKBArticle(long userId, long resourcePrimKey) voidunlockKBArticle(long userId, long resourcePrimKey, boolean force) voidunsubscribeGroupKBArticles(long userId, long groupId) voidunsubscribeKBArticle(long userId, long resourcePrimKey) updateAndUnlockKBArticle(long userId, long resourcePrimKey, String title, String content, String description, String[] sections, String sourceURL, Date displayDate, Date expirationDate, Date reviewDate, String[] selectedFileNames, long[] removeFileEntryIds, com.liferay.portal.kernel.service.ServiceContext serviceContext) updateKBArticle(long userId, long resourcePrimKey, String title, String content, String description, String[] sections, String sourceURL, Date displayDate, Date expirationDate, Date reviewDate, String[] selectedFileNames, long[] removeFileEntryIds, com.liferay.portal.kernel.service.ServiceContext serviceContext) updateKBArticle(KBArticle kbArticle) Updates the kb article in the database or adds it if it does not yet exist.voidupdateKBArticleAsset(long userId, KBArticle kbArticle, long[] assetCategoryIds, String[] assetTagNames, long[] assetLinkEntryIds) voidupdateKBArticleResources(KBArticle kbArticle, String[] groupPermissions, String[] guestPermissions) voidupdateKBArticlesPriorities(Map<Long, Double> resourcePrimKeyToPriorityMap) voidupdatePriority(long resourcePrimKey, double priority) updateStatus(long userId, long resourcePrimKey, int status, com.liferay.portal.kernel.service.ServiceContext serviceContext) <R,E extends Throwable>
RupdateWithUnsafeFunction(com.liferay.petra.function.UnsafeFunction<com.liferay.portal.kernel.service.persistence.change.tracking.CTPersistence<KBArticle>, R, E> updateUnsafeFunction)
-
Constructor Details
-
KBArticleLocalServiceWrapper
public KBArticleLocalServiceWrapper() -
KBArticleLocalServiceWrapper
-
-
Method Details
-
addAttachment
public com.liferay.portal.kernel.repository.model.FileEntry addAttachment(long userId, long resourcePrimKey, String fileName, InputStream inputStream, String mimeType) throws com.liferay.portal.kernel.exception.PortalException - Specified by:
addAttachmentin interfaceKBArticleLocalService- Throws:
com.liferay.portal.kernel.exception.PortalException
-
addKBArticle
Adds the kb article to the database. Also notifies the appropriate model listeners.Important: Inspect KBArticleLocalServiceImpl 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.
- Specified by:
addKBArticlein interfaceKBArticleLocalService- Parameters:
kbArticle- the kb article- Returns:
- the kb article that was added
-
addKBArticle
public KBArticle addKBArticle(String externalReferenceCode, long userId, long parentResourceClassNameId, long parentResourcePrimKey, String title, String urlTitle, String content, String description, String[] sections, String sourceURL, Date displayDate, Date expirationDate, Date reviewDate, String[] selectedFileNames, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException - Specified by:
addKBArticlein interfaceKBArticleLocalService- Throws:
com.liferay.portal.kernel.exception.PortalException
-
addKBArticleResources
public void addKBArticleResources(KBArticle kbArticle, boolean addGroupPermissions, boolean addGuestPermissions) throws com.liferay.portal.kernel.exception.PortalException - Specified by:
addKBArticleResourcesin interfaceKBArticleLocalService- Throws:
com.liferay.portal.kernel.exception.PortalException
-
addKBArticleResources
public void addKBArticleResources(KBArticle kbArticle, com.liferay.portal.kernel.service.permission.ModelPermissions modelPermissions) throws com.liferay.portal.kernel.exception.PortalException - Specified by:
addKBArticleResourcesin interfaceKBArticleLocalService- Throws:
com.liferay.portal.kernel.exception.PortalException
-
addKBArticleResources
public void addKBArticleResources(long kbArticleId, boolean addGroupPermissions, boolean addGuestPermissions) throws com.liferay.portal.kernel.exception.PortalException - Specified by:
addKBArticleResourcesin interfaceKBArticleLocalService- Throws:
com.liferay.portal.kernel.exception.PortalException
-
addKBArticlesMarkdown
public int addKBArticlesMarkdown(long userId, long groupId, long parentKbFolderId, String fileName, boolean prioritizeByNumericalPrefix, InputStream inputStream, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException - Specified by:
addKBArticlesMarkdownin interfaceKBArticleLocalService- Throws:
com.liferay.portal.kernel.exception.PortalException
-
addTempAttachment
public void addTempAttachment(long groupId, long userId, String fileName, String tempFolderName, InputStream inputStream, String mimeType) throws com.liferay.portal.kernel.exception.PortalException - Specified by:
addTempAttachmentin interfaceKBArticleLocalService- Throws:
com.liferay.portal.kernel.exception.PortalException
-
checkKBArticles
public void checkKBArticles(long companyId) throws com.liferay.portal.kernel.exception.PortalException - Specified by:
checkKBArticlesin interfaceKBArticleLocalService- Throws:
com.liferay.portal.kernel.exception.PortalException
-
createKBArticle
Creates a new kb article with the primary key. Does not add the kb article to the database.- Specified by:
createKBArticlein interfaceKBArticleLocalService- Parameters:
kbArticleId- the primary key for the new kb article- Returns:
- the new kb article
-
createPersistedModel
public com.liferay.portal.kernel.model.PersistedModel createPersistedModel(Serializable primaryKeyObj) throws com.liferay.portal.kernel.exception.PortalException - Specified by:
createPersistedModelin interfaceKBArticleLocalService- Specified by:
createPersistedModelin interfacecom.liferay.portal.kernel.service.PersistedModelLocalService- Throws:
PortalExceptioncom.liferay.portal.kernel.exception.PortalException
-
deleteGroupKBArticles
public void deleteGroupKBArticles(long groupId) throws com.liferay.portal.kernel.exception.PortalException - Specified by:
deleteGroupKBArticlesin interfaceKBArticleLocalService- Throws:
com.liferay.portal.kernel.exception.PortalException
-
deleteKBArticle
public KBArticle deleteKBArticle(KBArticle kbArticle) throws com.liferay.portal.kernel.exception.PortalException Deletes the kb article from the database. Also notifies the appropriate model listeners.Important: Inspect KBArticleLocalServiceImpl 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.
- Specified by:
deleteKBArticlein interfaceKBArticleLocalService- Parameters:
kbArticle- the kb article- Returns:
- the kb article that was removed
- Throws:
PortalExceptioncom.liferay.portal.kernel.exception.PortalException
-
deleteKBArticle
public KBArticle deleteKBArticle(long kbArticleId) throws com.liferay.portal.kernel.exception.PortalException Deletes the kb article with the primary key from the database. Also notifies the appropriate model listeners.Important: Inspect KBArticleLocalServiceImpl 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.
- Specified by:
deleteKBArticlein interfaceKBArticleLocalService- Parameters:
kbArticleId- the primary key of the kb article- Returns:
- the kb article that was removed
- Throws:
PortalException- if a kb article with the primary key could not be foundcom.liferay.portal.kernel.exception.PortalException
-
deleteKBArticle
public KBArticle deleteKBArticle(long userId, long resourcePrimKey, int version) throws com.liferay.portal.kernel.exception.PortalException - Specified by:
deleteKBArticlein interfaceKBArticleLocalService- Throws:
com.liferay.portal.kernel.exception.PortalException
-
deleteKBArticles
public void deleteKBArticles(long groupId, long parentResourcePrimKey) throws com.liferay.portal.kernel.exception.PortalException - Specified by:
deleteKBArticlesin interfaceKBArticleLocalService- Throws:
com.liferay.portal.kernel.exception.PortalException
-
deleteKBArticles
public void deleteKBArticles(long groupId, long parentResourcePrimKey, boolean includeTrashedEntries) throws com.liferay.portal.kernel.exception.PortalException - Specified by:
deleteKBArticlesin interfaceKBArticleLocalService- Throws:
com.liferay.portal.kernel.exception.PortalException
-
deleteKBArticles
public void deleteKBArticles(long[] resourcePrimKeys) throws com.liferay.portal.kernel.exception.PortalException - Specified by:
deleteKBArticlesin interfaceKBArticleLocalService- Throws:
com.liferay.portal.kernel.exception.PortalException
-
deletePersistedModel
public com.liferay.portal.kernel.model.PersistedModel deletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel) throws com.liferay.portal.kernel.exception.PortalException - Specified by:
deletePersistedModelin interfaceKBArticleLocalService- Specified by:
deletePersistedModelin interfacecom.liferay.portal.kernel.service.PersistedModelLocalService- Throws:
PortalExceptioncom.liferay.portal.kernel.exception.PortalException
-
deleteTempAttachment
public void deleteTempAttachment(long groupId, long userId, String fileName, String tempFolderName) throws com.liferay.portal.kernel.exception.PortalException - Specified by:
deleteTempAttachmentin interfaceKBArticleLocalService- Throws:
com.liferay.portal.kernel.exception.PortalException
-
dslQuery
public <T> T dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) - Specified by:
dslQueryin interfaceKBArticleLocalService- Specified by:
dslQueryin interfacecom.liferay.portal.kernel.service.PersistedModelLocalService
-
dslQueryCount
public int dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) - Specified by:
dslQueryCountin interfaceKBArticleLocalService- Specified by:
dslQueryCountin interfacecom.liferay.portal.kernel.service.PersistedModelLocalService
-
dynamicQuery
public com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery()- Specified by:
dynamicQueryin interfaceKBArticleLocalService
-
dynamicQuery
Performs a dynamic query on the database and returns the matching rows.- Specified by:
dynamicQueryin interfaceKBArticleLocalService- Parameters:
dynamicQuery- the dynamic query- Returns:
- the matching rows
-
dynamicQuery
public <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 - startinstances.startandendare not primary keys, they are indexes in the result set. Thus,0refers to the first result in the set. Setting bothstartandendtocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POSwill return the full result set. IforderByComparatoris specified, then the query will include the given ORDER BY logic. IforderByComparatoris absent, then the query will include the default ORDER BY logic fromcom.liferay.knowledge.base.model.impl.KBArticleModelImpl.- Specified by:
dynamicQueryin interfaceKBArticleLocalService- 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
public <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 - startinstances.startandendare not primary keys, they are indexes in the result set. Thus,0refers to the first result in the set. Setting bothstartandendtocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POSwill return the full result set. IforderByComparatoris specified, then the query will include the given ORDER BY logic. IforderByComparatoris absent, then the query will include the default ORDER BY logic fromcom.liferay.knowledge.base.model.impl.KBArticleModelImpl.- Specified by:
dynamicQueryin interfaceKBArticleLocalService- 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
public long dynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) Returns the number of rows matching the dynamic query.- Specified by:
dynamicQueryCountin interfaceKBArticleLocalService- Parameters:
dynamicQuery- the dynamic query- Returns:
- the number of rows matching the dynamic query
-
dynamicQueryCount
public 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.- Specified by:
dynamicQueryCountin interfaceKBArticleLocalService- Parameters:
dynamicQuery- the dynamic queryprojection- the projection to apply to the query- Returns:
- the number of rows matching the dynamic query
-
expireKBArticle
public KBArticle expireKBArticle(long userId, long resourcePrimKey, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException - Specified by:
expireKBArticlein interfaceKBArticleLocalService- Throws:
com.liferay.portal.kernel.exception.PortalException
-
fetchFirstChildKBArticle
- Specified by:
fetchFirstChildKBArticlein interfaceKBArticleLocalService
-
fetchKBArticle
- Specified by:
fetchKBArticlein interfaceKBArticleLocalService
-
fetchKBArticle
- Specified by:
fetchKBArticlein interfaceKBArticleLocalService
-
fetchKBArticleByUrlTitle
- Specified by:
fetchKBArticleByUrlTitlein interfaceKBArticleLocalService
-
fetchKBArticleByUrlTitle
- Specified by:
fetchKBArticleByUrlTitlein interfaceKBArticleLocalService
-
fetchKBArticleByUuidAndGroupId
Returns the kb article matching the UUID and group.- Specified by:
fetchKBArticleByUuidAndGroupIdin interfaceKBArticleLocalService- Parameters:
uuid- the kb article's UUIDgroupId- the primary key of the group- Returns:
- the matching kb article, or
nullif a matching kb article could not be found
-
fetchLatestKBArticle
- Specified by:
fetchLatestKBArticlein interfaceKBArticleLocalService
-
fetchLatestKBArticle
- Specified by:
fetchLatestKBArticlein interfaceKBArticleLocalService
-
fetchLatestKBArticleByExternalReferenceCode
public KBArticle fetchLatestKBArticleByExternalReferenceCode(long groupId, String externalReferenceCode) - Specified by:
fetchLatestKBArticleByExternalReferenceCodein interfaceKBArticleLocalService
-
fetchLatestKBArticleByUrlTitle
public KBArticle fetchLatestKBArticleByUrlTitle(long groupId, long kbFolderId, String urlTitle, int status) - Specified by:
fetchLatestKBArticleByUrlTitlein interfaceKBArticleLocalService
-
fetchPersistedModel
public com.liferay.portal.kernel.model.PersistedModel fetchPersistedModel(Serializable primaryKeyObj) - Specified by:
fetchPersistedModelin interfaceKBArticleLocalService- Specified by:
fetchPersistedModelin interfacecom.liferay.portal.kernel.service.PersistedModelLocalService
-
getActionableDynamicQuery
public com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery()- Specified by:
getActionableDynamicQueryin interfaceKBArticleLocalService
-
getAllDescendantKBArticles
public List<KBArticle> getAllDescendantKBArticles(long resourcePrimKey, int status, com.liferay.portal.kernel.util.OrderByComparator<KBArticle> orderByComparator) - Specified by:
getAllDescendantKBArticlesin interfaceKBArticleLocalService
-
getCompanyKBArticles
public List<KBArticle> getCompanyKBArticles(long companyId, int status, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<KBArticle> orderByComparator) - Specified by:
getCompanyKBArticlesin interfaceKBArticleLocalService
-
getCompanyKBArticlesCount
public int getCompanyKBArticlesCount(long companyId, int status) - Specified by:
getCompanyKBArticlesCountin interfaceKBArticleLocalService
-
getExportActionableDynamicQuery
public com.liferay.portal.kernel.dao.orm.ExportActionableDynamicQuery getExportActionableDynamicQuery(com.liferay.exportimport.kernel.lar.PortletDataContext portletDataContext) - Specified by:
getExportActionableDynamicQueryin interfaceKBArticleLocalService
-
getGroupKBArticles
public List<KBArticle> getGroupKBArticles(long groupId, int status, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<KBArticle> orderByComparator) - Specified by:
getGroupKBArticlesin interfaceKBArticleLocalService
-
getGroupKBArticlesCount
public int getGroupKBArticlesCount(long groupId, int status) - Specified by:
getGroupKBArticlesCountin interfaceKBArticleLocalService
-
getIndexableActionableDynamicQuery
public com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()- Specified by:
getIndexableActionableDynamicQueryin interfaceKBArticleLocalService
-
getKBArticle
public KBArticle getKBArticle(long kbArticleId) throws com.liferay.portal.kernel.exception.PortalException Returns the kb article with the primary key.- Specified by:
getKBArticlein interfaceKBArticleLocalService- Parameters:
kbArticleId- the primary key of the kb article- Returns:
- the kb article
- Throws:
PortalException- if a kb article with the primary key could not be foundcom.liferay.portal.kernel.exception.PortalException
-
getKBArticle
public KBArticle getKBArticle(long resourcePrimKey, int version) throws com.liferay.portal.kernel.exception.PortalException - Specified by:
getKBArticlein interfaceKBArticleLocalService- Throws:
com.liferay.portal.kernel.exception.PortalException
-
getKBArticleAndAllDescendantKBArticles
public List<KBArticle> getKBArticleAndAllDescendantKBArticles(long resourcePrimKey, int status, com.liferay.portal.kernel.util.OrderByComparator<KBArticle> orderByComparator) - Specified by:
getKBArticleAndAllDescendantKBArticlesin interfaceKBArticleLocalService
-
getKBArticleByUrlTitle
public KBArticle getKBArticleByUrlTitle(long groupId, long kbFolderId, String urlTitle) throws com.liferay.portal.kernel.exception.PortalException - Specified by:
getKBArticleByUrlTitlein interfaceKBArticleLocalService- Throws:
com.liferay.portal.kernel.exception.PortalException
-
getKBArticleByUrlTitle
public KBArticle getKBArticleByUrlTitle(long groupId, String kbFolderUrlTitle, String urlTitle) throws com.liferay.portal.kernel.exception.PortalException - Specified by:
getKBArticleByUrlTitlein interfaceKBArticleLocalService- Throws:
com.liferay.portal.kernel.exception.PortalException
-
getKBArticleByUuidAndGroupId
public KBArticle getKBArticleByUuidAndGroupId(String uuid, long groupId) throws com.liferay.portal.kernel.exception.PortalException Returns the kb article matching the UUID and group.- Specified by:
getKBArticleByUuidAndGroupIdin interfaceKBArticleLocalService- Parameters:
uuid- the kb article's UUIDgroupId- the primary key of the group- Returns:
- the matching kb article
- Throws:
PortalException- if a matching kb article could not be foundcom.liferay.portal.kernel.exception.PortalException
-
getKBArticles
Returns a range of all the kb articles.Useful when paginating results. Returns a maximum of
end - startinstances.startandendare not primary keys, they are indexes in the result set. Thus,0refers to the first result in the set. Setting bothstartandendtocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POSwill return the full result set. IforderByComparatoris specified, then the query will include the given ORDER BY logic. IforderByComparatoris absent, then the query will include the default ORDER BY logic fromcom.liferay.knowledge.base.model.impl.KBArticleModelImpl.- Specified by:
getKBArticlesin interfaceKBArticleLocalService- Parameters:
start- the lower bound of the range of kb articlesend- the upper bound of the range of kb articles (not inclusive)- Returns:
- the range of kb articles
-
getKBArticles
public List<KBArticle> getKBArticles(long groupId, long parentResourcePrimKey, int status, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<KBArticle> orderByComparator) - Specified by:
getKBArticlesin interfaceKBArticleLocalService
-
getKBArticles
public List<KBArticle> getKBArticles(long[] resourcePrimKeys, int status, com.liferay.portal.kernel.util.OrderByComparator<KBArticle> orderByComparator) - Specified by:
getKBArticlesin interfaceKBArticleLocalService
-
getKBArticlesByUuidAndCompanyId
Returns all the kb articles matching the UUID and company.- Specified by:
getKBArticlesByUuidAndCompanyIdin interfaceKBArticleLocalService- Parameters:
uuid- the UUID of the kb articlescompanyId- the primary key of the company- Returns:
- the matching kb articles, or an empty list if no matches were found
-
getKBArticlesByUuidAndCompanyId
public List<KBArticle> getKBArticlesByUuidAndCompanyId(String uuid, long companyId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<KBArticle> orderByComparator) Returns a range of kb articles matching the UUID and company.- Specified by:
getKBArticlesByUuidAndCompanyIdin interfaceKBArticleLocalService- Parameters:
uuid- the UUID of the kb articlescompanyId- the primary key of the companystart- the lower bound of the range of kb articlesend- the upper bound of the range of kb articles (not inclusive)orderByComparator- the comparator to order the results by (optionallynull)- Returns:
- the range of matching kb articles, or an empty list if no matches were found
-
getKBArticlesCount
public int getKBArticlesCount()Returns the number of kb articles.- Specified by:
getKBArticlesCountin interfaceKBArticleLocalService- Returns:
- the number of kb articles
-
getKBArticlesCount
public int getKBArticlesCount(long groupId, long parentResourcePrimKey, int status) - Specified by:
getKBArticlesCountin interfaceKBArticleLocalService
-
getKBArticleVersions
public List<KBArticle> getKBArticleVersions(long resourcePrimKey, int status, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<KBArticle> orderByComparator) - Specified by:
getKBArticleVersionsin interfaceKBArticleLocalService
-
getKBArticleVersionsCount
public int getKBArticleVersionsCount(long resourcePrimKey, int status) - Specified by:
getKBArticleVersionsCountin interfaceKBArticleLocalService
-
getKBFolderKBArticles
- Specified by:
getKBFolderKBArticlesin interfaceKBArticleLocalService
-
getKBFolderKBArticlesCount
public int getKBFolderKBArticlesCount(long groupId, long kbFolderId, int status) - Specified by:
getKBFolderKBArticlesCountin interfaceKBArticleLocalService
-
getLatestKBArticle
public KBArticle getLatestKBArticle(long resourcePrimKey) throws com.liferay.portal.kernel.exception.PortalException - Specified by:
getLatestKBArticlein interfaceKBArticleLocalService- Throws:
com.liferay.portal.kernel.exception.PortalException
-
getLatestKBArticle
public KBArticle getLatestKBArticle(long resourcePrimKey, int status) throws com.liferay.portal.kernel.exception.PortalException - Specified by:
getLatestKBArticlein interfaceKBArticleLocalService- Throws:
com.liferay.portal.kernel.exception.PortalException
-
getLatestKBArticle
public KBArticle getLatestKBArticle(long resourcePrimKey, int[] statuses) throws com.liferay.portal.kernel.exception.PortalException - Specified by:
getLatestKBArticlein interfaceKBArticleLocalService- Throws:
com.liferay.portal.kernel.exception.PortalException
-
getLatestKBArticleByExternalReferenceCode
public KBArticle getLatestKBArticleByExternalReferenceCode(long groupId, String externalReferenceCode) throws com.liferay.portal.kernel.exception.PortalException - Specified by:
getLatestKBArticleByExternalReferenceCodein interfaceKBArticleLocalService- Throws:
com.liferay.portal.kernel.exception.PortalException
-
getLatestKBArticleByUrlTitle
public KBArticle getLatestKBArticleByUrlTitle(long groupId, long kbFolderId, String urlTitle, int status) throws com.liferay.portal.kernel.exception.PortalException - Specified by:
getLatestKBArticleByUrlTitlein interfaceKBArticleLocalService- Throws:
com.liferay.portal.kernel.exception.PortalException
-
getOSGiServiceIdentifier
Returns the OSGi service identifier.- Specified by:
getOSGiServiceIdentifierin interfaceKBArticleLocalService- Returns:
- the OSGi service identifier
-
getPersistedModel
public List<? extends com.liferay.portal.kernel.model.PersistedModel> getPersistedModel(long resourcePrimKey) throws com.liferay.portal.kernel.exception.PortalException - Specified by:
getPersistedModelin interfaceKBArticleLocalService- Specified by:
getPersistedModelin interfacecom.liferay.portal.kernel.service.PersistedResourcedModelLocalService- Throws:
com.liferay.portal.kernel.exception.PortalException
-
getPersistedModel
public com.liferay.portal.kernel.model.PersistedModel getPersistedModel(Serializable primaryKeyObj) throws com.liferay.portal.kernel.exception.PortalException - Specified by:
getPersistedModelin interfaceKBArticleLocalService- Specified by:
getPersistedModelin interfacecom.liferay.portal.kernel.service.PersistedModelLocalService- Throws:
PortalExceptioncom.liferay.portal.kernel.exception.PortalException
-
getPreviousAndNextKBArticles
public KBArticle[] getPreviousAndNextKBArticles(long kbArticleId) throws com.liferay.portal.kernel.exception.PortalException - Specified by:
getPreviousAndNextKBArticlesin interfaceKBArticleLocalService- Throws:
com.liferay.portal.kernel.exception.PortalException
-
getSectionsKBArticles
public List<KBArticle> getSectionsKBArticles(long groupId, String[] sections, int status, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<KBArticle> orderByComparator) - Specified by:
getSectionsKBArticlesin interfaceKBArticleLocalService
-
getSectionsKBArticlesCount
- Specified by:
getSectionsKBArticlesCountin interfaceKBArticleLocalService
-
getTempAttachmentNames
public String[] getTempAttachmentNames(long groupId, long userId, String tempFolderName) throws com.liferay.portal.kernel.exception.PortalException - Specified by:
getTempAttachmentNamesin interfaceKBArticleLocalService- Throws:
com.liferay.portal.kernel.exception.PortalException
-
hasKBArticleLock
public boolean hasKBArticleLock(long userId, long resourcePrimKey) - Specified by:
hasKBArticleLockin interfaceKBArticleLocalService
-
incrementViewCount
public void incrementViewCount(long userId, long resourcePrimKey, int increment) throws com.liferay.portal.kernel.exception.PortalException - Specified by:
incrementViewCountin interfaceKBArticleLocalService- Throws:
com.liferay.portal.kernel.exception.PortalException
-
lockKBArticle
public com.liferay.portal.kernel.lock.Lock lockKBArticle(long userId, long resourcePrimKey) throws com.liferay.portal.kernel.exception.PortalException - Specified by:
lockKBArticlein interfaceKBArticleLocalService- Throws:
com.liferay.portal.kernel.exception.PortalException
-
moveDependentKBArticlesToTrash
public void moveDependentKBArticlesToTrash(long parentResourcePrimKey, long trashEntryId) throws com.liferay.portal.kernel.exception.PortalException - Specified by:
moveDependentKBArticlesToTrashin interfaceKBArticleLocalService- Throws:
com.liferay.portal.kernel.exception.PortalException
-
moveDependentKBArticleToTrash
public void moveDependentKBArticleToTrash(KBArticle kbArticle, long trashEntryId) throws com.liferay.portal.kernel.exception.PortalException - Specified by:
moveDependentKBArticleToTrashin interfaceKBArticleLocalService- Throws:
com.liferay.portal.kernel.exception.PortalException
-
moveKBArticle
public void moveKBArticle(long userId, long resourcePrimKey, long parentResourceClassNameId, long parentResourcePrimKey, double priority) throws com.liferay.portal.kernel.exception.PortalException - Specified by:
moveKBArticlein interfaceKBArticleLocalService- Throws:
com.liferay.portal.kernel.exception.PortalException
-
moveKBArticleFromTrash
public void moveKBArticleFromTrash(long userId, long resourcePrimKey, long parentResourceClassNameId, long parentResourcePrimKey) throws com.liferay.portal.kernel.exception.PortalException - Specified by:
moveKBArticleFromTrashin interfaceKBArticleLocalService- Throws:
com.liferay.portal.kernel.exception.PortalException
-
moveKBArticleToTrash
public KBArticle moveKBArticleToTrash(long userId, long resourcePrimKey) throws com.liferay.portal.kernel.exception.PortalException - Specified by:
moveKBArticleToTrashin interfaceKBArticleLocalService- Throws:
com.liferay.portal.kernel.exception.PortalException
-
restoreDependentKBArticleFromTrash
public void restoreDependentKBArticleFromTrash(KBArticle kbArticle) throws com.liferay.portal.kernel.exception.PortalException - Specified by:
restoreDependentKBArticleFromTrashin interfaceKBArticleLocalService- Throws:
com.liferay.portal.kernel.exception.PortalException
-
restoreDependentKBArticlesFromTrash
public void restoreDependentKBArticlesFromTrash(long parentResourcePrimKey) throws com.liferay.portal.kernel.exception.PortalException - Specified by:
restoreDependentKBArticlesFromTrashin interfaceKBArticleLocalService- Throws:
com.liferay.portal.kernel.exception.PortalException
-
restoreKBArticleFromTrash
public void restoreKBArticleFromTrash(long userId, long resourcePrimKey) throws com.liferay.portal.kernel.exception.PortalException - Specified by:
restoreKBArticleFromTrashin interfaceKBArticleLocalService- Throws:
com.liferay.portal.kernel.exception.PortalException
-
revertKBArticle
public KBArticle revertKBArticle(long userId, long resourcePrimKey, int version, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException - Specified by:
revertKBArticlein interfaceKBArticleLocalService- Throws:
com.liferay.portal.kernel.exception.PortalException
-
search
public List<KBArticle> search(long groupId, String title, String content, int status, Date startDate, Date endDate, boolean andOperator, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<KBArticle> orderByComparator) - Specified by:
searchin interfaceKBArticleLocalService
-
subscribeGroupKBArticles
public void subscribeGroupKBArticles(long userId, long groupId) throws com.liferay.portal.kernel.exception.PortalException - Specified by:
subscribeGroupKBArticlesin interfaceKBArticleLocalService- Throws:
com.liferay.portal.kernel.exception.PortalException
-
subscribeKBArticle
public void subscribeKBArticle(long userId, long groupId, long resourcePrimKey) throws com.liferay.portal.kernel.exception.PortalException - Specified by:
subscribeKBArticlein interfaceKBArticleLocalService- Throws:
com.liferay.portal.kernel.exception.PortalException
-
unlockKBArticle
public void unlockKBArticle(long userId, long resourcePrimKey) - Specified by:
unlockKBArticlein interfaceKBArticleLocalService
-
unlockKBArticle
public void unlockKBArticle(long userId, long resourcePrimKey, boolean force) - Specified by:
unlockKBArticlein interfaceKBArticleLocalService
-
unsubscribeGroupKBArticles
public void unsubscribeGroupKBArticles(long userId, long groupId) throws com.liferay.portal.kernel.exception.PortalException - Specified by:
unsubscribeGroupKBArticlesin interfaceKBArticleLocalService- Throws:
com.liferay.portal.kernel.exception.PortalException
-
unsubscribeKBArticle
public void unsubscribeKBArticle(long userId, long resourcePrimKey) throws com.liferay.portal.kernel.exception.PortalException - Specified by:
unsubscribeKBArticlein interfaceKBArticleLocalService- Throws:
com.liferay.portal.kernel.exception.PortalException
-
updateAndUnlockKBArticle
public KBArticle updateAndUnlockKBArticle(long userId, long resourcePrimKey, String title, String content, String description, String[] sections, String sourceURL, Date displayDate, Date expirationDate, Date reviewDate, String[] selectedFileNames, long[] removeFileEntryIds, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException - Specified by:
updateAndUnlockKBArticlein interfaceKBArticleLocalService- Throws:
com.liferay.portal.kernel.exception.PortalException
-
updateKBArticle
Updates the kb article in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.Important: Inspect KBArticleLocalServiceImpl 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.
- Specified by:
updateKBArticlein interfaceKBArticleLocalService- Parameters:
kbArticle- the kb article- Returns:
- the kb article that was updated
-
updateKBArticle
public KBArticle updateKBArticle(long userId, long resourcePrimKey, String title, String content, String description, String[] sections, String sourceURL, Date displayDate, Date expirationDate, Date reviewDate, String[] selectedFileNames, long[] removeFileEntryIds, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException - Specified by:
updateKBArticlein interfaceKBArticleLocalService- Throws:
com.liferay.portal.kernel.exception.PortalException
-
updateKBArticleAsset
public void updateKBArticleAsset(long userId, KBArticle kbArticle, long[] assetCategoryIds, String[] assetTagNames, long[] assetLinkEntryIds) throws com.liferay.portal.kernel.exception.PortalException - Specified by:
updateKBArticleAssetin interfaceKBArticleLocalService- Throws:
com.liferay.portal.kernel.exception.PortalException
-
updateKBArticleResources
public void updateKBArticleResources(KBArticle kbArticle, String[] groupPermissions, String[] guestPermissions) throws com.liferay.portal.kernel.exception.PortalException - Specified by:
updateKBArticleResourcesin interfaceKBArticleLocalService- Throws:
com.liferay.portal.kernel.exception.PortalException
-
updateKBArticlesPriorities
public void updateKBArticlesPriorities(Map<Long, Double> resourcePrimKeyToPriorityMap) throws com.liferay.portal.kernel.exception.PortalException- Specified by:
updateKBArticlesPrioritiesin interfaceKBArticleLocalService- Throws:
com.liferay.portal.kernel.exception.PortalException
-
updatePriority
public void updatePriority(long resourcePrimKey, double priority) - Specified by:
updatePriorityin interfaceKBArticleLocalService
-
updateStatus
public KBArticle updateStatus(long userId, long resourcePrimKey, int status, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException - Specified by:
updateStatusin interfaceKBArticleLocalService- Throws:
com.liferay.portal.kernel.exception.PortalException
-
getBasePersistence
public com.liferay.portal.kernel.service.persistence.BasePersistence<?> getBasePersistence()- Specified by:
getBasePersistencein interfacecom.liferay.portal.kernel.service.PersistedModelLocalService
-
getCTPersistence
public com.liferay.portal.kernel.service.persistence.change.tracking.CTPersistence<KBArticle> getCTPersistence()- Specified by:
getCTPersistencein interfacecom.liferay.portal.kernel.service.change.tracking.CTService<KBArticle>- Specified by:
getCTPersistencein interfaceKBArticleLocalService
-
getModelClass
- Specified by:
getModelClassin interfacecom.liferay.portal.kernel.service.change.tracking.CTService<KBArticle>- Specified by:
getModelClassin interfaceKBArticleLocalService
-
updateWithUnsafeFunction
public <R,E extends Throwable> R updateWithUnsafeFunction(com.liferay.petra.function.UnsafeFunction<com.liferay.portal.kernel.service.persistence.change.tracking.CTPersistence<KBArticle>, R, throws EE> updateUnsafeFunction) - Specified by:
updateWithUnsafeFunctionin interfacecom.liferay.portal.kernel.service.change.tracking.CTService<KBArticle>- Specified by:
updateWithUnsafeFunctionin interfaceKBArticleLocalService- Throws:
E extends Throwable
-
getWrappedService
- Specified by:
getWrappedServicein interfacecom.liferay.portal.kernel.service.ServiceWrapper<KBArticleLocalService>
-
setWrappedService
- Specified by:
setWrappedServicein interfacecom.liferay.portal.kernel.service.ServiceWrapper<KBArticleLocalService>
-