com.liferay.knowledge.base.service

Class KBArticleLocalServiceUtil

java.lang.Object

com.liferay.knowledge.base.service.KBArticleLocalServiceUtil

public class KBArticleLocalServiceUtil
extends java.lang.Object

Provides the local service utility for KBArticle. This utility wraps com.liferay.knowledge.base.service.impl.KBArticleLocalServiceImpl and is an access point for service operations in application layer code running on the local server. Methods of this service will not have security checks based on the propagated JAAS credentials because this service can only be accessed from within the same VM.

See Also:

KBArticleLocalService

Generated:

Constructor Summary

Constructors

Constructor and Description
KBArticleLocalServiceUtil()

Method Summary

Modifier and Type	Method and Description
static com.liferay.portal.kernel.repository.model.FileEntry	addAttachment(long userId, long resourcePrimKey, java.lang.String fileName, java.io.InputStream inputStream, java.lang.String mimeType)
static KBArticle	addKBArticle(KBArticle kbArticle) Adds the kb article to the database.
static KBArticle	addKBArticle(long userId, long parentResourceClassNameId, long parentResourcePrimKey, java.lang.String title, java.lang.String urlTitle, java.lang.String content, java.lang.String description, java.lang.String sourceURL, java.lang.String[] sections, java.lang.String[] selectedFileNames, com.liferay.portal.kernel.service.ServiceContext serviceContext)
static void	addKBArticleResources(KBArticle kbArticle, boolean addGroupPermissions, boolean addGuestPermissions)
static void	addKBArticleResources(KBArticle kbArticle, com.liferay.portal.kernel.service.permission.ModelPermissions modelPermissions)
static void	addKBArticleResources(long kbArticleId, boolean addGroupPermissions, boolean addGuestPermissions)
static int	addKBArticlesMarkdown(long userId, long groupId, long parentKbFolderId, java.lang.String fileName, boolean prioritizeByNumericalPrefix, java.io.InputStream inputStream, com.liferay.portal.kernel.service.ServiceContext serviceContext)
static void	addTempAttachment(long groupId, long userId, java.lang.String fileName, java.lang.String tempFolderName, java.io.InputStream inputStream, java.lang.String mimeType)
static KBArticle	createKBArticle(long kbArticleId) Creates a new kb article with the primary key.
static com.liferay.portal.kernel.model.PersistedModel	createPersistedModel(java.io.Serializable primaryKeyObj)
static void	deleteGroupKBArticles(long groupId)
static KBArticle	deleteKBArticle(KBArticle kbArticle) Deletes the kb article from the database.
static KBArticle	deleteKBArticle(long kbArticleId) Deletes the kb article with the primary key from the database.
static void	deleteKBArticles(long[] resourcePrimKeys)
static void	deleteKBArticles(long groupId, long parentResourcePrimKey)
static com.liferay.portal.kernel.model.PersistedModel	deletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel)
static void	deleteTempAttachment(long groupId, long userId, java.lang.String fileName, java.lang.String tempFolderName)
static <T> T	dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)
static int	dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)
static com.liferay.portal.kernel.dao.orm.DynamicQuery	dynamicQuery()
static <T> java.util.List<T>	dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.
static <T> java.util.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.
static <T> java.util.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.
static long	dynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) Returns the number of rows matching the dynamic query.
static 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.
static KBArticle	fetchFirstChildKBArticle(long groupId, long parentResourcePrimKey)
static KBArticle	fetchKBArticle(long kbArticleId)
static KBArticle	fetchKBArticle(long resourcePrimKey, long groupId, int version)
static KBArticle	fetchKBArticleByUrlTitle(long groupId, long kbFolderId, java.lang.String urlTitle)
static KBArticle	fetchKBArticleByUrlTitle(long groupId, java.lang.String kbFolderUrlTitle, java.lang.String urlTitle)
static KBArticle	fetchKBArticleByUuidAndGroupId(java.lang.String uuid, long groupId) Returns the kb article matching the UUID and group.
static KBArticle	fetchLatestKBArticle(long resourcePrimKey, int status)
static KBArticle	fetchLatestKBArticle(long resourcePrimKey, long groupId)
static KBArticle	fetchLatestKBArticleByUrlTitle(long groupId, long kbFolderId, java.lang.String urlTitle, int status)
static com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery	getActionableDynamicQuery()
static java.util.List<KBArticle>	getAllDescendantKBArticles(long resourcePrimKey, int status, com.liferay.portal.kernel.util.OrderByComparator<KBArticle> orderByComparator)
static java.util.List<KBArticle>	getCompanyKBArticles(long companyId, int status, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<KBArticle> orderByComparator)
static int	getCompanyKBArticlesCount(long companyId, int status)
static com.liferay.portal.kernel.dao.orm.ExportActionableDynamicQuery	getExportActionableDynamicQuery(com.liferay.exportimport.kernel.lar.PortletDataContext portletDataContext)
static java.util.List<KBArticle>	getGroupKBArticles(long groupId, int status, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<KBArticle> orderByComparator)
static int	getGroupKBArticlesCount(long groupId, int status)
static com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery	getIndexableActionableDynamicQuery()
static KBArticle	getKBArticle(long kbArticleId) Returns the kb article with the primary key.
static KBArticle	getKBArticle(long resourcePrimKey, int version)
static java.util.List<KBArticle>	getKBArticleAndAllDescendantKBArticles(long resourcePrimKey, int status, com.liferay.portal.kernel.util.OrderByComparator<KBArticle> orderByComparator)
static KBArticle	getKBArticleByUrlTitle(long groupId, long kbFolderId, java.lang.String urlTitle)
static KBArticle	getKBArticleByUrlTitle(long groupId, java.lang.String kbFolderUrlTitle, java.lang.String urlTitle)
static KBArticle	getKBArticleByUuidAndGroupId(java.lang.String uuid, long groupId) Returns the kb article matching the UUID and group.
static java.util.List<KBArticle>	getKBArticles(int start, int end) Returns a range of all the kb articles.
static java.util.List<KBArticle>	getKBArticles(long[] resourcePrimKeys, int status, com.liferay.portal.kernel.util.OrderByComparator<KBArticle> orderByComparator)
static java.util.List<KBArticle>	getKBArticles(long groupId, long parentResourcePrimKey, int status, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<KBArticle> orderByComparator)
static java.util.List<KBArticle>	getKBArticlesByUuidAndCompanyId(java.lang.String uuid, long companyId) Returns all the kb articles matching the UUID and company.
static java.util.List<KBArticle>	getKBArticlesByUuidAndCompanyId(java.lang.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.
static int	getKBArticlesCount() Returns the number of kb articles.
static int	getKBArticlesCount(long groupId, long parentResourcePrimKey, int status)
static java.util.List<KBArticle>	getKBArticleVersions(long resourcePrimKey, int status, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<KBArticle> orderByComparator)
static int	getKBArticleVersionsCount(long resourcePrimKey, int status)
static java.util.List<KBArticle>	getKBFolderKBArticles(long groupId, long kbFolderId)
static int	getKBFolderKBArticlesCount(long groupId, long kbFolderId, int status)
static KBArticle	getLatestKBArticle(long resourcePrimKey, int status)
static KBArticle	getLatestKBArticleByUrlTitle(long groupId, long kbFolderId, java.lang.String urlTitle, int status)
static java.lang.String	getOSGiServiceIdentifier() Returns the OSGi service identifier.
static java.util.List<? extends com.liferay.portal.kernel.model.PersistedModel>	getPersistedModel(long resourcePrimKey)
static com.liferay.portal.kernel.model.PersistedModel	getPersistedModel(java.io.Serializable primaryKeyObj)
static KBArticle[]	getPreviousAndNextKBArticles(long kbArticleId)
static java.util.List<KBArticle>	getSectionsKBArticles(long groupId, java.lang.String[] sections, int status, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<KBArticle> orderByComparator)
static int	getSectionsKBArticlesCount(long groupId, java.lang.String[] sections, int status)
static KBArticleLocalService	getService()
static java.lang.String[]	getTempAttachmentNames(long groupId, long userId, java.lang.String tempFolderName)
static void	incrementViewCount(long userId, long resourcePrimKey, int increment)
static void	moveKBArticle(long userId, long resourcePrimKey, long parentResourceClassNameId, long parentResourcePrimKey, double priority)
static KBArticle	revertKBArticle(long userId, long resourcePrimKey, int version, com.liferay.portal.kernel.service.ServiceContext serviceContext)
static java.util.List<KBArticle>	search(long groupId, java.lang.String title, java.lang.String content, int status, java.util.Date startDate, java.util.Date endDate, boolean andOperator, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<KBArticle> orderByComparator)
static void	subscribeGroupKBArticles(long userId, long groupId)
static void	subscribeKBArticle(long userId, long groupId, long resourcePrimKey)
static void	unsubscribeGroupKBArticles(long userId, long groupId)
static void	unsubscribeKBArticle(long userId, long resourcePrimKey)
static KBArticle	updateKBArticle(KBArticle kbArticle) Updates the kb article in the database or adds it if it does not yet exist.
static KBArticle	updateKBArticle(long userId, long resourcePrimKey, java.lang.String title, java.lang.String content, java.lang.String description, java.lang.String sourceURL, java.lang.String[] sections, java.lang.String[] selectedFileNames, long[] removeFileEntryIds, com.liferay.portal.kernel.service.ServiceContext serviceContext)
static void	updateKBArticleAsset(long userId, KBArticle kbArticle, long[] assetCategoryIds, java.lang.String[] assetTagNames, long[] assetLinkEntryIds)
static void	updateKBArticleResources(KBArticle kbArticle, java.lang.String[] groupPermissions, java.lang.String[] guestPermissions)
static void	updateKBArticlesPriorities(java.util.Map<java.lang.Long,java.lang.Double> resourcePrimKeyToPriorityMap)
static void	updatePriority(long resourcePrimKey, double priority)
static KBArticle	updateStatus(long userId, long resourcePrimKey, int status, com.liferay.portal.kernel.service.ServiceContext serviceContext)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

KBArticleLocalServiceUtil

public KBArticleLocalServiceUtil()

Method Detail

addAttachment

public static com.liferay.portal.kernel.repository.model.FileEntry addAttachment(long userId,
                                                                                 long resourcePrimKey,
                                                                                 java.lang.String fileName,
                                                                                 java.io.InputStream inputStream,
                                                                                 java.lang.String mimeType)
                                                                          throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

addKBArticle

public static KBArticle addKBArticle(KBArticle kbArticle)

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.

Parameters:

kbArticle - the kb article

Returns:

the kb article that was added

addKBArticle

public static KBArticle addKBArticle(long userId,
                                     long parentResourceClassNameId,
                                     long parentResourcePrimKey,
                                     java.lang.String title,
                                     java.lang.String urlTitle,
                                     java.lang.String content,
                                     java.lang.String description,
                                     java.lang.String sourceURL,
                                     java.lang.String[] sections,
                                     java.lang.String[] selectedFileNames,
                                     com.liferay.portal.kernel.service.ServiceContext serviceContext)
                              throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

addKBArticleResources

public static void addKBArticleResources(KBArticle kbArticle,
                                         boolean addGroupPermissions,
                                         boolean addGuestPermissions)
                                  throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

addKBArticleResources

public static void addKBArticleResources(KBArticle kbArticle,
                                         com.liferay.portal.kernel.service.permission.ModelPermissions modelPermissions)
                                  throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

addKBArticleResources

public static void addKBArticleResources(long kbArticleId,
                                         boolean addGroupPermissions,
                                         boolean addGuestPermissions)
                                  throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

addKBArticlesMarkdown

public static int addKBArticlesMarkdown(long userId,
                                        long groupId,
                                        long parentKbFolderId,
                                        java.lang.String fileName,
                                        boolean prioritizeByNumericalPrefix,
                                        java.io.InputStream inputStream,
                                        com.liferay.portal.kernel.service.ServiceContext serviceContext)
                                 throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

addTempAttachment

public static void addTempAttachment(long groupId,
                                     long userId,
                                     java.lang.String fileName,
                                     java.lang.String tempFolderName,
                                     java.io.InputStream inputStream,
                                     java.lang.String mimeType)
                              throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

createKBArticle

public static KBArticle createKBArticle(long kbArticleId)

Creates a new kb article with the primary key. Does not add the kb article to the database.

Parameters:

kbArticleId - the primary key for the new kb article

Returns:

the new kb article

createPersistedModel

public static com.liferay.portal.kernel.model.PersistedModel createPersistedModel(java.io.Serializable primaryKeyObj)
                                                                           throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

deleteGroupKBArticles

public static void deleteGroupKBArticles(long groupId)
                                  throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

deleteKBArticle

public static 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.

Parameters:

kbArticle - the kb article

Returns:

the kb article that was removed

Throws:

com.liferay.portal.kernel.exception.PortalException

deleteKBArticle

public static 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.

Parameters:

kbArticleId - the primary key of the kb article

Returns:

the kb article that was removed

Throws:

com.liferay.portal.kernel.exception.PortalException - if a kb article with the primary key could not be found

deleteKBArticles

public static void deleteKBArticles(long groupId,
                                    long parentResourcePrimKey)
                             throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

deleteKBArticles

public static void deleteKBArticles(long[] resourcePrimKeys)
                             throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

deletePersistedModel

public static com.liferay.portal.kernel.model.PersistedModel deletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel)
                                                                           throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

deleteTempAttachment

public static void deleteTempAttachment(long groupId,
                                        long userId,
                                        java.lang.String fileName,
                                        java.lang.String tempFolderName)
                                 throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

dslQuery

public static <T> T dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)

dslQueryCount

public static int dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)

dynamicQuery

public static com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery()

dynamicQuery

public static <T> java.util.List<T> dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)

Performs a dynamic query on the database and returns the matching rows.

Parameters:

dynamicQuery - the dynamic query

Returns:

the matching rows

dynamicQuery

public static <T> java.util.List<T> dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery,
                                                 int start,
                                                 int end)

Performs a dynamic query on the database and returns a range of the matching rows.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS will return the full result set. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent, then the query will include the default ORDER BY logic from com.liferay.knowledge.base.model.impl.KBArticleModelImpl.

Parameters:

dynamicQuery - the dynamic query

start - the lower bound of the range of model instances

end - the upper bound of the range of model instances (not inclusive)

Returns:

the range of matching rows

dynamicQuery

public static <T> java.util.List<T> dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery,
                                                 int start,
                                                 int end,
                                                 com.liferay.portal.kernel.util.OrderByComparator<T> orderByComparator)

Performs a dynamic query on the database and returns an ordered range of the matching rows.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS will return the full result set. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent, then the query will include the default ORDER BY logic from com.liferay.knowledge.base.model.impl.KBArticleModelImpl.

Parameters:

dynamicQuery - the dynamic query

start - the lower bound of the range of model instances

end - the upper bound of the range of model instances (not inclusive)

orderByComparator - the comparator to order the results by (optionally null)

Returns:

the ordered range of matching rows

dynamicQueryCount

public static long dynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)

Returns the number of rows matching the dynamic query.

Parameters:

dynamicQuery - the dynamic query

Returns:

the number of rows matching the dynamic query

dynamicQueryCount

public static long dynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery,
                                     com.liferay.portal.kernel.dao.orm.Projection projection)

Returns the number of rows matching the dynamic query.

Parameters:

dynamicQuery - the dynamic query

projection - the projection to apply to the query

Returns:

the number of rows matching the dynamic query

fetchFirstChildKBArticle

public static KBArticle fetchFirstChildKBArticle(long groupId,
                                                 long parentResourcePrimKey)

fetchKBArticle

public static KBArticle fetchKBArticle(long kbArticleId)

fetchKBArticle

public static KBArticle fetchKBArticle(long resourcePrimKey,
                                       long groupId,
                                       int version)

fetchKBArticleByUrlTitle

public static KBArticle fetchKBArticleByUrlTitle(long groupId,
                                                 long kbFolderId,
                                                 java.lang.String urlTitle)

fetchKBArticleByUrlTitle

public static KBArticle fetchKBArticleByUrlTitle(long groupId,
                                                 java.lang.String kbFolderUrlTitle,
                                                 java.lang.String urlTitle)

fetchKBArticleByUuidAndGroupId

public static KBArticle fetchKBArticleByUuidAndGroupId(java.lang.String uuid,
                                                       long groupId)

Returns the kb article matching the UUID and group.

Parameters:

uuid - the kb article's UUID

groupId - the primary key of the group

Returns:

the matching kb article, or null if a matching kb article could not be found

fetchLatestKBArticle

public static KBArticle fetchLatestKBArticle(long resourcePrimKey,
                                             int status)

fetchLatestKBArticle

public static KBArticle fetchLatestKBArticle(long resourcePrimKey,
                                             long groupId)

fetchLatestKBArticleByUrlTitle

public static KBArticle fetchLatestKBArticleByUrlTitle(long groupId,
                                                       long kbFolderId,
                                                       java.lang.String urlTitle,
                                                       int status)

getActionableDynamicQuery

public static com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery()

getAllDescendantKBArticles

public static java.util.List<KBArticle> getAllDescendantKBArticles(long resourcePrimKey,
                                                                   int status,
                                                                   com.liferay.portal.kernel.util.OrderByComparator<KBArticle> orderByComparator)

getCompanyKBArticles

public static java.util.List<KBArticle> getCompanyKBArticles(long companyId,
                                                             int status,
                                                             int start,
                                                             int end,
                                                             com.liferay.portal.kernel.util.OrderByComparator<KBArticle> orderByComparator)

getCompanyKBArticlesCount

public static int getCompanyKBArticlesCount(long companyId,
                                            int status)

getExportActionableDynamicQuery

public static com.liferay.portal.kernel.dao.orm.ExportActionableDynamicQuery getExportActionableDynamicQuery(com.liferay.exportimport.kernel.lar.PortletDataContext portletDataContext)

getGroupKBArticles

public static java.util.List<KBArticle> getGroupKBArticles(long groupId,
                                                           int status,
                                                           int start,
                                                           int end,
                                                           com.liferay.portal.kernel.util.OrderByComparator<KBArticle> orderByComparator)

getGroupKBArticlesCount

public static int getGroupKBArticlesCount(long groupId,
                                          int status)

getIndexableActionableDynamicQuery

public static com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()

getKBArticle

public static KBArticle getKBArticle(long kbArticleId)
                              throws com.liferay.portal.kernel.exception.PortalException

Returns the kb article with the primary key.

Parameters:

kbArticleId - the primary key of the kb article

Returns:

the kb article

Throws:

com.liferay.portal.kernel.exception.PortalException - if a kb article with the primary key could not be found

getKBArticle

public static KBArticle getKBArticle(long resourcePrimKey,
                                     int version)
                              throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

getKBArticleAndAllDescendantKBArticles

public static java.util.List<KBArticle> getKBArticleAndAllDescendantKBArticles(long resourcePrimKey,
                                                                               int status,
                                                                               com.liferay.portal.kernel.util.OrderByComparator<KBArticle> orderByComparator)

getKBArticleByUrlTitle

public static KBArticle getKBArticleByUrlTitle(long groupId,
                                               long kbFolderId,
                                               java.lang.String urlTitle)
                                        throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

getKBArticleByUrlTitle

public static KBArticle getKBArticleByUrlTitle(long groupId,
                                               java.lang.String kbFolderUrlTitle,
                                               java.lang.String urlTitle)
                                        throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

getKBArticleByUuidAndGroupId

public static KBArticle getKBArticleByUuidAndGroupId(java.lang.String uuid,
                                                     long groupId)
                                              throws com.liferay.portal.kernel.exception.PortalException

Returns the kb article matching the UUID and group.

Parameters:

uuid - the kb article's UUID

groupId - the primary key of the group

Returns:

the matching kb article

Throws:

com.liferay.portal.kernel.exception.PortalException - if a matching kb article could not be found

getKBArticles

public static java.util.List<KBArticle> getKBArticles(int start,
                                                      int end)

Returns a range of all the kb articles.

Useful when paginating results. Returns a maximum of end - start instances. start and end are not primary keys, they are indexes in the result set. Thus, 0 refers to the first result in the set. Setting both start and end to com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS will return the full result set. If orderByComparator is specified, then the query will include the given ORDER BY logic. If orderByComparator is absent, then the query will include the default ORDER BY logic from com.liferay.knowledge.base.model.impl.KBArticleModelImpl.

Parameters:

start - the lower bound of the range of kb articles

end - the upper bound of the range of kb articles (not inclusive)

Returns:

the range of kb articles

getKBArticles

public static java.util.List<KBArticle> getKBArticles(long groupId,
                                                      long parentResourcePrimKey,
                                                      int status,
                                                      int start,
                                                      int end,
                                                      com.liferay.portal.kernel.util.OrderByComparator<KBArticle> orderByComparator)

getKBArticles

public static java.util.List<KBArticle> getKBArticles(long[] resourcePrimKeys,
                                                      int status,
                                                      com.liferay.portal.kernel.util.OrderByComparator<KBArticle> orderByComparator)

getKBArticlesByUuidAndCompanyId

public static java.util.List<KBArticle> getKBArticlesByUuidAndCompanyId(java.lang.String uuid,
                                                                        long companyId)

Returns all the kb articles matching the UUID and company.

Parameters:

uuid - the UUID of the kb articles

companyId - the primary key of the company

Returns:

the matching kb articles, or an empty list if no matches were found

getKBArticlesByUuidAndCompanyId

public static java.util.List<KBArticle> getKBArticlesByUuidAndCompanyId(java.lang.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.

Parameters:

uuid - the UUID of the kb articles

companyId - the primary key of the company

start - the lower bound of the range of kb articles

end - the upper bound of the range of kb articles (not inclusive)

orderByComparator - the comparator to order the results by (optionally null)

Returns:

the range of matching kb articles, or an empty list if no matches were found

getKBArticlesCount

public static int getKBArticlesCount()

Returns the number of kb articles.

Returns:

the number of kb articles

getKBArticlesCount

public static int getKBArticlesCount(long groupId,
                                     long parentResourcePrimKey,
                                     int status)

getKBArticleVersions

public static java.util.List<KBArticle> getKBArticleVersions(long resourcePrimKey,
                                                             int status,
                                                             int start,
                                                             int end,
                                                             com.liferay.portal.kernel.util.OrderByComparator<KBArticle> orderByComparator)

getKBArticleVersionsCount

public static int getKBArticleVersionsCount(long resourcePrimKey,
                                            int status)

getKBFolderKBArticles

public static java.util.List<KBArticle> getKBFolderKBArticles(long groupId,
                                                              long kbFolderId)

getKBFolderKBArticlesCount

public static int getKBFolderKBArticlesCount(long groupId,
                                             long kbFolderId,
                                             int status)

getLatestKBArticle

public static KBArticle getLatestKBArticle(long resourcePrimKey,
                                           int status)
                                    throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

getLatestKBArticleByUrlTitle

public static KBArticle getLatestKBArticleByUrlTitle(long groupId,
                                                     long kbFolderId,
                                                     java.lang.String urlTitle,
                                                     int status)
                                              throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

getOSGiServiceIdentifier

public static java.lang.String getOSGiServiceIdentifier()

Returns the OSGi service identifier.

Returns:

the OSGi service identifier

getPersistedModel

public static java.util.List<? extends com.liferay.portal.kernel.model.PersistedModel> getPersistedModel(long resourcePrimKey)
                                                                                                  throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

getPersistedModel

public static com.liferay.portal.kernel.model.PersistedModel getPersistedModel(java.io.Serializable primaryKeyObj)
                                                                        throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

getPreviousAndNextKBArticles

public static KBArticle[] getPreviousAndNextKBArticles(long kbArticleId)
                                                throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

getSectionsKBArticles

public static java.util.List<KBArticle> getSectionsKBArticles(long groupId,
                                                              java.lang.String[] sections,
                                                              int status,
                                                              int start,
                                                              int end,
                                                              com.liferay.portal.kernel.util.OrderByComparator<KBArticle> orderByComparator)

getSectionsKBArticlesCount

public static int getSectionsKBArticlesCount(long groupId,
                                             java.lang.String[] sections,
                                             int status)

getTempAttachmentNames

public static java.lang.String[] getTempAttachmentNames(long groupId,
                                                        long userId,
                                                        java.lang.String tempFolderName)
                                                 throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

incrementViewCount

public static void incrementViewCount(long userId,
                                      long resourcePrimKey,
                                      int increment)
                               throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

moveKBArticle

public static void moveKBArticle(long userId,
                                 long resourcePrimKey,
                                 long parentResourceClassNameId,
                                 long parentResourcePrimKey,
                                 double priority)
                          throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

revertKBArticle

public static KBArticle revertKBArticle(long userId,
                                        long resourcePrimKey,
                                        int version,
                                        com.liferay.portal.kernel.service.ServiceContext serviceContext)
                                 throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

search

public static java.util.List<KBArticle> search(long groupId,
                                               java.lang.String title,
                                               java.lang.String content,
                                               int status,
                                               java.util.Date startDate,
                                               java.util.Date endDate,
                                               boolean andOperator,
                                               int start,
                                               int end,
                                               com.liferay.portal.kernel.util.OrderByComparator<KBArticle> orderByComparator)

subscribeGroupKBArticles

public static void subscribeGroupKBArticles(long userId,
                                            long groupId)
                                     throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

subscribeKBArticle

public static void subscribeKBArticle(long userId,
                                      long groupId,
                                      long resourcePrimKey)
                               throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

unsubscribeGroupKBArticles

public static void unsubscribeGroupKBArticles(long userId,
                                              long groupId)
                                       throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

unsubscribeKBArticle

public static void unsubscribeKBArticle(long userId,
                                        long resourcePrimKey)
                                 throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

updateKBArticle

public static KBArticle updateKBArticle(KBArticle kbArticle)

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.

Parameters:

kbArticle - the kb article

Returns:

the kb article that was updated

updateKBArticle

public static KBArticle updateKBArticle(long userId,
                                        long resourcePrimKey,
                                        java.lang.String title,
                                        java.lang.String content,
                                        java.lang.String description,
                                        java.lang.String sourceURL,
                                        java.lang.String[] sections,
                                        java.lang.String[] selectedFileNames,
                                        long[] removeFileEntryIds,
                                        com.liferay.portal.kernel.service.ServiceContext serviceContext)
                                 throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

updateKBArticleAsset

public static void updateKBArticleAsset(long userId,
                                        KBArticle kbArticle,
                                        long[] assetCategoryIds,
                                        java.lang.String[] assetTagNames,
                                        long[] assetLinkEntryIds)
                                 throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

updateKBArticleResources

public static void updateKBArticleResources(KBArticle kbArticle,
                                            java.lang.String[] groupPermissions,
                                            java.lang.String[] guestPermissions)
                                     throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

updateKBArticlesPriorities

public static void updateKBArticlesPriorities(java.util.Map<java.lang.Long,java.lang.Double> resourcePrimKeyToPriorityMap)
                                       throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

updatePriority

public static void updatePriority(long resourcePrimKey,
                                  double priority)

updateStatus

public static KBArticle updateStatus(long userId,
                                     long resourcePrimKey,
                                     int status,
                                     com.liferay.portal.kernel.service.ServiceContext serviceContext)
                              throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

getService

public static KBArticleLocalService getService()