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.FileEntry
addAttachment
(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) void
addKBArticleResources
(long kbArticleId, boolean addGroupPermissions, boolean addGuestPermissions) void
addKBArticleResources
(KBArticle kbArticle, boolean addGroupPermissions, boolean addGuestPermissions) void
addKBArticleResources
(KBArticle kbArticle, com.liferay.portal.kernel.service.permission.ModelPermissions modelPermissions) int
addKBArticlesMarkdown
(long userId, long groupId, long parentKbFolderId, String fileName, boolean prioritizeByNumericalPrefix, InputStream inputStream, com.liferay.portal.kernel.service.ServiceContext serviceContext) void
addTempAttachment
(long groupId, long userId, String fileName, String tempFolderName, InputStream inputStream, String mimeType) void
checkKBArticles
(long companyId) createKBArticle
(long kbArticleId) Creates a new kb article with the primary key.com.liferay.portal.kernel.model.PersistedModel
createPersistedModel
(Serializable primaryKeyObj) void
deleteGroupKBArticles
(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.void
deleteKBArticles
(long[] resourcePrimKeys) void
deleteKBArticles
(long groupId, long parentResourcePrimKey) void
deleteKBArticles
(long groupId, long parentResourcePrimKey, boolean includeTrashedEntries) com.liferay.portal.kernel.model.PersistedModel
deletePersistedModel
(com.liferay.portal.kernel.model.PersistedModel persistedModel) void
deleteTempAttachment
(long groupId, long userId, String fileName, String tempFolderName) <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.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.PersistedModel
fetchPersistedModel
(Serializable primaryKeyObj) com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery
getAllDescendantKBArticles
(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) int
getCompanyKBArticlesCount
(long companyId, int status) com.liferay.portal.kernel.service.persistence.change.tracking.CTPersistence<KBArticle>
com.liferay.portal.kernel.dao.orm.ExportActionableDynamicQuery
getExportActionableDynamicQuery
(com.liferay.exportimport.kernel.lar.PortletDataContext portletDataContext) getGroupKBArticles
(long groupId, int status, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<KBArticle> orderByComparator) int
getGroupKBArticlesCount
(long groupId, int status) com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery
getKBArticle
(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.int
Returns the number of kb articles.int
getKBArticlesCount
(long groupId, long parentResourcePrimKey, int status) getKBArticleVersions
(long resourcePrimKey, int status, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<KBArticle> orderByComparator) int
getKBArticleVersionsCount
(long resourcePrimKey, int status) getKBFolderKBArticles
(long groupId, long kbFolderId) int
getKBFolderKBArticlesCount
(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.PersistedModel
getPersistedModel
(Serializable primaryKeyObj) getPreviousAndNextKBArticles
(long kbArticleId) getSectionsKBArticles
(long groupId, String[] sections, int status, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<KBArticle> orderByComparator) int
getSectionsKBArticlesCount
(long groupId, String[] sections, int status) String[]
getTempAttachmentNames
(long groupId, long userId, String tempFolderName) boolean
hasKBArticleLock
(long userId, long resourcePrimKey) void
incrementViewCount
(long userId, long resourcePrimKey, int increment) com.liferay.portal.kernel.lock.Lock
lockKBArticle
(long userId, long resourcePrimKey) void
moveDependentKBArticlesToTrash
(long parentResourcePrimKey, long trashEntryId) void
moveDependentKBArticleToTrash
(KBArticle kbArticle, long trashEntryId) void
moveKBArticle
(long userId, long resourcePrimKey, long parentResourceClassNameId, long parentResourcePrimKey, double priority) void
moveKBArticleFromTrash
(long userId, long resourcePrimKey, long parentResourceClassNameId, long parentResourcePrimKey) moveKBArticleToTrash
(long userId, long resourcePrimKey) void
restoreDependentKBArticleFromTrash
(KBArticle kbArticle) void
restoreDependentKBArticlesFromTrash
(long parentResourcePrimKey) void
restoreKBArticleFromTrash
(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) void
setWrappedService
(KBArticleLocalService kbArticleLocalService) void
subscribeGroupKBArticles
(long userId, long groupId) void
subscribeKBArticle
(long userId, long groupId, long resourcePrimKey) void
unlockKBArticle
(long userId, long resourcePrimKey) void
unlockKBArticle
(long userId, long resourcePrimKey, boolean force) void
unsubscribeGroupKBArticles
(long userId, long groupId) void
unsubscribeKBArticle
(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.void
updateKBArticleAsset
(long userId, KBArticle kbArticle, long[] assetCategoryIds, String[] assetTagNames, long[] assetLinkEntryIds) void
updateKBArticleResources
(KBArticle kbArticle, String[] groupPermissions, String[] guestPermissions) void
updateKBArticlesPriorities
(Map<Long, Double> resourcePrimKeyToPriorityMap) void
updatePriority
(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:
addAttachment
in 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:
addKBArticle
in 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:
addKBArticle
in 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:
addKBArticleResources
in 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:
addKBArticleResources
in 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:
addKBArticleResources
in 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:
addKBArticlesMarkdown
in 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:
addTempAttachment
in interfaceKBArticleLocalService
- Throws:
com.liferay.portal.kernel.exception.PortalException
-
checkKBArticles
public void checkKBArticles(long companyId) throws com.liferay.portal.kernel.exception.PortalException - Specified by:
checkKBArticles
in 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:
createKBArticle
in 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:
createPersistedModel
in interfaceKBArticleLocalService
- Specified by:
createPersistedModel
in interfacecom.liferay.portal.kernel.service.PersistedModelLocalService
- Throws:
PortalException
com.liferay.portal.kernel.exception.PortalException
-
deleteGroupKBArticles
public void deleteGroupKBArticles(long groupId) throws com.liferay.portal.kernel.exception.PortalException - Specified by:
deleteGroupKBArticles
in 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:
deleteKBArticle
in interfaceKBArticleLocalService
- Parameters:
kbArticle
- the kb article- Returns:
- the kb article that was removed
- Throws:
PortalException
com.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:
deleteKBArticle
in 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:
deleteKBArticle
in 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:
deleteKBArticles
in 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:
deleteKBArticles
in interfaceKBArticleLocalService
- Throws:
com.liferay.portal.kernel.exception.PortalException
-
deleteKBArticles
public void deleteKBArticles(long[] resourcePrimKeys) throws com.liferay.portal.kernel.exception.PortalException - Specified by:
deleteKBArticles
in 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:
deletePersistedModel
in interfaceKBArticleLocalService
- Specified by:
deletePersistedModel
in interfacecom.liferay.portal.kernel.service.PersistedModelLocalService
- Throws:
PortalException
com.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:
deleteTempAttachment
in interfaceKBArticleLocalService
- Throws:
com.liferay.portal.kernel.exception.PortalException
-
dslQuery
public <T> T dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) - Specified by:
dslQuery
in interfaceKBArticleLocalService
- Specified by:
dslQuery
in interfacecom.liferay.portal.kernel.service.PersistedModelLocalService
-
dslQueryCount
public int dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) - Specified by:
dslQueryCount
in interfaceKBArticleLocalService
- Specified by:
dslQueryCount
in interfacecom.liferay.portal.kernel.service.PersistedModelLocalService
-
dynamicQuery
public com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery()- Specified by:
dynamicQuery
in interfaceKBArticleLocalService
-
dynamicQuery
Performs a dynamic query on the database and returns the matching rows.- Specified by:
dynamicQuery
in 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 - 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.KBArticleModelImpl
.- Specified by:
dynamicQuery
in 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 - 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.KBArticleModelImpl
.- Specified by:
dynamicQuery
in 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:
dynamicQueryCount
in 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:
dynamicQueryCount
in 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:
expireKBArticle
in interfaceKBArticleLocalService
- Throws:
com.liferay.portal.kernel.exception.PortalException
-
fetchFirstChildKBArticle
- Specified by:
fetchFirstChildKBArticle
in interfaceKBArticleLocalService
-
fetchKBArticle
- Specified by:
fetchKBArticle
in interfaceKBArticleLocalService
-
fetchKBArticle
- Specified by:
fetchKBArticle
in interfaceKBArticleLocalService
-
fetchKBArticleByUrlTitle
- Specified by:
fetchKBArticleByUrlTitle
in interfaceKBArticleLocalService
-
fetchKBArticleByUrlTitle
- Specified by:
fetchKBArticleByUrlTitle
in interfaceKBArticleLocalService
-
fetchKBArticleByUuidAndGroupId
Returns the kb article matching the UUID and group.- Specified by:
fetchKBArticleByUuidAndGroupId
in interfaceKBArticleLocalService
- Parameters:
uuid
- the kb article's UUIDgroupId
- the primary key of the group- Returns:
- the matching kb article, or
null
if a matching kb article could not be found
-
fetchLatestKBArticle
- Specified by:
fetchLatestKBArticle
in interfaceKBArticleLocalService
-
fetchLatestKBArticle
- Specified by:
fetchLatestKBArticle
in interfaceKBArticleLocalService
-
fetchLatestKBArticleByExternalReferenceCode
public KBArticle fetchLatestKBArticleByExternalReferenceCode(long groupId, String externalReferenceCode) - Specified by:
fetchLatestKBArticleByExternalReferenceCode
in interfaceKBArticleLocalService
-
fetchLatestKBArticleByUrlTitle
public KBArticle fetchLatestKBArticleByUrlTitle(long groupId, long kbFolderId, String urlTitle, int status) - Specified by:
fetchLatestKBArticleByUrlTitle
in interfaceKBArticleLocalService
-
fetchPersistedModel
public com.liferay.portal.kernel.model.PersistedModel fetchPersistedModel(Serializable primaryKeyObj) - Specified by:
fetchPersistedModel
in interfaceKBArticleLocalService
- Specified by:
fetchPersistedModel
in interfacecom.liferay.portal.kernel.service.PersistedModelLocalService
-
getActionableDynamicQuery
public com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery()- Specified by:
getActionableDynamicQuery
in interfaceKBArticleLocalService
-
getAllDescendantKBArticles
public List<KBArticle> getAllDescendantKBArticles(long resourcePrimKey, int status, com.liferay.portal.kernel.util.OrderByComparator<KBArticle> orderByComparator) - Specified by:
getAllDescendantKBArticles
in interfaceKBArticleLocalService
-
getCompanyKBArticles
public List<KBArticle> getCompanyKBArticles(long companyId, int status, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<KBArticle> orderByComparator) - Specified by:
getCompanyKBArticles
in interfaceKBArticleLocalService
-
getCompanyKBArticlesCount
public int getCompanyKBArticlesCount(long companyId, int status) - Specified by:
getCompanyKBArticlesCount
in interfaceKBArticleLocalService
-
getExportActionableDynamicQuery
public com.liferay.portal.kernel.dao.orm.ExportActionableDynamicQuery getExportActionableDynamicQuery(com.liferay.exportimport.kernel.lar.PortletDataContext portletDataContext) - Specified by:
getExportActionableDynamicQuery
in interfaceKBArticleLocalService
-
getGroupKBArticles
public List<KBArticle> getGroupKBArticles(long groupId, int status, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<KBArticle> orderByComparator) - Specified by:
getGroupKBArticles
in interfaceKBArticleLocalService
-
getGroupKBArticlesCount
public int getGroupKBArticlesCount(long groupId, int status) - Specified by:
getGroupKBArticlesCount
in interfaceKBArticleLocalService
-
getIndexableActionableDynamicQuery
public com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()- Specified by:
getIndexableActionableDynamicQuery
in interfaceKBArticleLocalService
-
getKBArticle
public KBArticle getKBArticle(long kbArticleId) throws com.liferay.portal.kernel.exception.PortalException Returns the kb article with the primary key.- Specified by:
getKBArticle
in 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:
getKBArticle
in 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:
getKBArticleAndAllDescendantKBArticles
in interfaceKBArticleLocalService
-
getKBArticleByUrlTitle
public KBArticle getKBArticleByUrlTitle(long groupId, long kbFolderId, String urlTitle) throws com.liferay.portal.kernel.exception.PortalException - Specified by:
getKBArticleByUrlTitle
in 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:
getKBArticleByUrlTitle
in 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:
getKBArticleByUuidAndGroupId
in 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 - 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.KBArticleModelImpl
.- Specified by:
getKBArticles
in 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:
getKBArticles
in interfaceKBArticleLocalService
-
getKBArticles
public List<KBArticle> getKBArticles(long[] resourcePrimKeys, int status, com.liferay.portal.kernel.util.OrderByComparator<KBArticle> orderByComparator) - Specified by:
getKBArticles
in interfaceKBArticleLocalService
-
getKBArticlesByUuidAndCompanyId
Returns all the kb articles matching the UUID and company.- Specified by:
getKBArticlesByUuidAndCompanyId
in 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:
getKBArticlesByUuidAndCompanyId
in 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:
getKBArticlesCount
in interfaceKBArticleLocalService
- Returns:
- the number of kb articles
-
getKBArticlesCount
public int getKBArticlesCount(long groupId, long parentResourcePrimKey, int status) - Specified by:
getKBArticlesCount
in interfaceKBArticleLocalService
-
getKBArticleVersions
public List<KBArticle> getKBArticleVersions(long resourcePrimKey, int status, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<KBArticle> orderByComparator) - Specified by:
getKBArticleVersions
in interfaceKBArticleLocalService
-
getKBArticleVersionsCount
public int getKBArticleVersionsCount(long resourcePrimKey, int status) - Specified by:
getKBArticleVersionsCount
in interfaceKBArticleLocalService
-
getKBFolderKBArticles
- Specified by:
getKBFolderKBArticles
in interfaceKBArticleLocalService
-
getKBFolderKBArticlesCount
public int getKBFolderKBArticlesCount(long groupId, long kbFolderId, int status) - Specified by:
getKBFolderKBArticlesCount
in interfaceKBArticleLocalService
-
getLatestKBArticle
public KBArticle getLatestKBArticle(long resourcePrimKey) throws com.liferay.portal.kernel.exception.PortalException - Specified by:
getLatestKBArticle
in 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:
getLatestKBArticle
in 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:
getLatestKBArticle
in 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:
getLatestKBArticleByExternalReferenceCode
in 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:
getLatestKBArticleByUrlTitle
in interfaceKBArticleLocalService
- Throws:
com.liferay.portal.kernel.exception.PortalException
-
getOSGiServiceIdentifier
Returns the OSGi service identifier.- Specified by:
getOSGiServiceIdentifier
in 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:
getPersistedModel
in interfaceKBArticleLocalService
- Specified by:
getPersistedModel
in 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:
getPersistedModel
in interfaceKBArticleLocalService
- Specified by:
getPersistedModel
in interfacecom.liferay.portal.kernel.service.PersistedModelLocalService
- Throws:
PortalException
com.liferay.portal.kernel.exception.PortalException
-
getPreviousAndNextKBArticles
public KBArticle[] getPreviousAndNextKBArticles(long kbArticleId) throws com.liferay.portal.kernel.exception.PortalException - Specified by:
getPreviousAndNextKBArticles
in 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:
getSectionsKBArticles
in interfaceKBArticleLocalService
-
getSectionsKBArticlesCount
- Specified by:
getSectionsKBArticlesCount
in interfaceKBArticleLocalService
-
getTempAttachmentNames
public String[] getTempAttachmentNames(long groupId, long userId, String tempFolderName) throws com.liferay.portal.kernel.exception.PortalException - Specified by:
getTempAttachmentNames
in interfaceKBArticleLocalService
- Throws:
com.liferay.portal.kernel.exception.PortalException
-
hasKBArticleLock
public boolean hasKBArticleLock(long userId, long resourcePrimKey) - Specified by:
hasKBArticleLock
in interfaceKBArticleLocalService
-
incrementViewCount
public void incrementViewCount(long userId, long resourcePrimKey, int increment) throws com.liferay.portal.kernel.exception.PortalException - Specified by:
incrementViewCount
in 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:
lockKBArticle
in 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:
moveDependentKBArticlesToTrash
in 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:
moveDependentKBArticleToTrash
in 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:
moveKBArticle
in 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:
moveKBArticleFromTrash
in 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:
moveKBArticleToTrash
in interfaceKBArticleLocalService
- Throws:
com.liferay.portal.kernel.exception.PortalException
-
restoreDependentKBArticleFromTrash
public void restoreDependentKBArticleFromTrash(KBArticle kbArticle) throws com.liferay.portal.kernel.exception.PortalException - Specified by:
restoreDependentKBArticleFromTrash
in interfaceKBArticleLocalService
- Throws:
com.liferay.portal.kernel.exception.PortalException
-
restoreDependentKBArticlesFromTrash
public void restoreDependentKBArticlesFromTrash(long parentResourcePrimKey) throws com.liferay.portal.kernel.exception.PortalException - Specified by:
restoreDependentKBArticlesFromTrash
in 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:
restoreKBArticleFromTrash
in 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:
revertKBArticle
in 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:
search
in interfaceKBArticleLocalService
-
subscribeGroupKBArticles
public void subscribeGroupKBArticles(long userId, long groupId) throws com.liferay.portal.kernel.exception.PortalException - Specified by:
subscribeGroupKBArticles
in 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:
subscribeKBArticle
in interfaceKBArticleLocalService
- Throws:
com.liferay.portal.kernel.exception.PortalException
-
unlockKBArticle
public void unlockKBArticle(long userId, long resourcePrimKey) - Specified by:
unlockKBArticle
in interfaceKBArticleLocalService
-
unlockKBArticle
public void unlockKBArticle(long userId, long resourcePrimKey, boolean force) - Specified by:
unlockKBArticle
in interfaceKBArticleLocalService
-
unsubscribeGroupKBArticles
public void unsubscribeGroupKBArticles(long userId, long groupId) throws com.liferay.portal.kernel.exception.PortalException - Specified by:
unsubscribeGroupKBArticles
in 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:
unsubscribeKBArticle
in 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:
updateAndUnlockKBArticle
in 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:
updateKBArticle
in 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:
updateKBArticle
in 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:
updateKBArticleAsset
in 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:
updateKBArticleResources
in 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:
updateKBArticlesPriorities
in interfaceKBArticleLocalService
- Throws:
com.liferay.portal.kernel.exception.PortalException
-
updatePriority
public void updatePriority(long resourcePrimKey, double priority) - Specified by:
updatePriority
in 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:
updateStatus
in interfaceKBArticleLocalService
- Throws:
com.liferay.portal.kernel.exception.PortalException
-
getBasePersistence
public com.liferay.portal.kernel.service.persistence.BasePersistence<?> getBasePersistence()- Specified by:
getBasePersistence
in interfacecom.liferay.portal.kernel.service.PersistedModelLocalService
-
getCTPersistence
public com.liferay.portal.kernel.service.persistence.change.tracking.CTPersistence<KBArticle> getCTPersistence()- Specified by:
getCTPersistence
in interfacecom.liferay.portal.kernel.service.change.tracking.CTService<KBArticle>
- Specified by:
getCTPersistence
in interfaceKBArticleLocalService
-
getModelClass
- Specified by:
getModelClass
in interfacecom.liferay.portal.kernel.service.change.tracking.CTService<KBArticle>
- Specified by:
getModelClass
in 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:
updateWithUnsafeFunction
in interfacecom.liferay.portal.kernel.service.change.tracking.CTService<KBArticle>
- Specified by:
updateWithUnsafeFunction
in interfaceKBArticleLocalService
- Throws:
E extends Throwable
-
getWrappedService
- Specified by:
getWrappedService
in interfacecom.liferay.portal.kernel.service.ServiceWrapper<KBArticleLocalService>
-
setWrappedService
- Specified by:
setWrappedService
in interfacecom.liferay.portal.kernel.service.ServiceWrapper<KBArticleLocalService>
-