com.liferay.knowledge.base.service

Interface KBArticleLocalService

All Superinterfaces:

com.liferay.portal.kernel.service.BaseLocalService, com.liferay.portal.kernel.service.PersistedModelLocalService, com.liferay.portal.kernel.service.PersistedResourcedModelLocalService

All Known Implementing Classes:

KBArticleLocalServiceWrapper

@ProviderType
 @Transactional(isolation=PORTAL,
               rollbackFor={com.liferay.portal.kernel.exception.PortalException.class,com.liferay.portal.kernel.exception.SystemException.class})
public interface KBArticleLocalService
extends com.liferay.portal.kernel.service.BaseLocalService, com.liferay.portal.kernel.service.PersistedModelLocalService, com.liferay.portal.kernel.service.PersistedResourcedModelLocalService

Provides the local service interface for KBArticle. 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:

KBArticleLocalServiceUtil

Generated:

Method Summary

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

Methods inherited from interface com.liferay.portal.kernel.service.PersistedModelLocalService

getBasePersistence

Method Detail

addAttachment

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

@Indexable(type=REINDEX)
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

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

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

Throws:

com.liferay.portal.kernel.exception.PortalException

addKBArticleResources

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

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

Throws:

com.liferay.portal.kernel.exception.PortalException

addKBArticlesMarkdown

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

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

@Transactional(enabled=false)
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

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

Specified by:

createPersistedModel in interface com.liferay.portal.kernel.service.PersistedModelLocalService

Throws:

com.liferay.portal.kernel.exception.PortalException

deleteGroupKBArticles

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

Throws:

com.liferay.portal.kernel.exception.PortalException

deleteKBArticle

@Indexable(type=DELETE)
 @SystemEvent(action=1,
             type=1)
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

@Indexable(type=DELETE)
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

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

Throws:

com.liferay.portal.kernel.exception.PortalException

deleteKBArticles

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

Throws:

com.liferay.portal.kernel.exception.PortalException

deletePersistedModel

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

Specified by:

deletePersistedModel in interface com.liferay.portal.kernel.service.PersistedModelLocalService

Throws:

com.liferay.portal.kernel.exception.PortalException

deleteTempAttachment

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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
<T> T dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)

dynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery()

dynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
<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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
<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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
<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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
long dynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)

Returns the number of rows matching the dynamic query.

Parameters:

dynamicQuery - the dynamic query

Returns:

the number of rows matching the dynamic query

dynamicQueryCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
long dynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery,
                                                                                          com.liferay.portal.kernel.dao.orm.Projection projection)

Returns the number of rows matching the dynamic query.

Parameters:

dynamicQuery - the dynamic query

projection - the projection to apply to the query

Returns:

the number of rows matching the dynamic query

fetchFirstChildKBArticle

@Transactional(propagation=SUPPORTS,
               readOnly=true)
KBArticle fetchFirstChildKBArticle(long groupId,
                                                                                                      long parentResourcePrimKey)

fetchKBArticle

@Transactional(propagation=SUPPORTS,
               readOnly=true)
KBArticle fetchKBArticle(long kbArticleId)

fetchKBArticle

@Transactional(propagation=SUPPORTS,
               readOnly=true)
KBArticle fetchKBArticle(long resourcePrimKey,
                                                                                            long groupId,
                                                                                            int version)

fetchKBArticleByUrlTitle

@Transactional(propagation=SUPPORTS,
               readOnly=true)
KBArticle fetchKBArticleByUrlTitle(long groupId,
                                                                                                      long kbFolderId,
                                                                                                      java.lang.String urlTitle)

fetchKBArticleByUrlTitle

@Transactional(propagation=SUPPORTS,
               readOnly=true)
KBArticle fetchKBArticleByUrlTitle(long groupId,
                                                                                                      java.lang.String kbFolderUrlTitle,
                                                                                                      java.lang.String urlTitle)

fetchKBArticleByUuidAndGroupId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
KBArticle fetchLatestKBArticle(long resourcePrimKey,
                                                                                                  int status)

fetchLatestKBArticle

@Transactional(propagation=SUPPORTS,
               readOnly=true)
KBArticle fetchLatestKBArticle(long resourcePrimKey,
                                                                                                  long groupId)

fetchLatestKBArticleByUrlTitle

@Transactional(propagation=SUPPORTS,
               readOnly=true)
KBArticle fetchLatestKBArticleByUrlTitle(long groupId,
                                                                                                            long kbFolderId,
                                                                                                            java.lang.String urlTitle,
                                                                                                            int status)

getActionableDynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery()

getAllDescendantKBArticles

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<KBArticle> getAllDescendantKBArticles(long resourcePrimKey,
                                                                                                                        int status,
                                                                                                                        com.liferay.portal.kernel.util.OrderByComparator<KBArticle> orderByComparator)

getCompanyKBArticles

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<KBArticle> getCompanyKBArticles(long companyId,
                                                                                                                  int status,
                                                                                                                  int start,
                                                                                                                  int end,
                                                                                                                  com.liferay.portal.kernel.util.OrderByComparator<KBArticle> orderByComparator)

getCompanyKBArticlesCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getCompanyKBArticlesCount(long companyId,
                                                                                                 int status)

getExportActionableDynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
com.liferay.portal.kernel.dao.orm.ExportActionableDynamicQuery getExportActionableDynamicQuery(com.liferay.exportimport.kernel.lar.PortletDataContext portletDataContext)

getGroupKBArticles

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<KBArticle> getGroupKBArticles(long groupId,
                                                                                                                int status,
                                                                                                                int start,
                                                                                                                int end,
                                                                                                                com.liferay.portal.kernel.util.OrderByComparator<KBArticle> orderByComparator)

getGroupKBArticlesCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getGroupKBArticlesCount(long groupId,
                                                                                               int status)

getIndexableActionableDynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()

getKBArticle

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
KBArticle getKBArticle(long resourcePrimKey,
                                                                                          int version)
                                                                                   throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

getKBArticleAndAllDescendantKBArticles

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<KBArticle> getKBArticleAndAllDescendantKBArticles(long resourcePrimKey,
                                                                                                                                    int status,
                                                                                                                                    com.liferay.portal.kernel.util.OrderByComparator<KBArticle> orderByComparator)

getKBArticleByUrlTitle

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<KBArticle> getKBArticles(long groupId,
                                                                                                           long parentResourcePrimKey,
                                                                                                           int status,
                                                                                                           int start,
                                                                                                           int end,
                                                                                                           com.liferay.portal.kernel.util.OrderByComparator<KBArticle> orderByComparator)

getKBArticles

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<KBArticle> getKBArticles(long[] resourcePrimKeys,
                                                                                                           int status,
                                                                                                           com.liferay.portal.kernel.util.OrderByComparator<KBArticle> orderByComparator)

getKBArticlesByUuidAndCompanyId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getKBArticlesCount()

Returns the number of kb articles.

Returns:

the number of kb articles

getKBArticlesCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getKBArticlesCount(long groupId,
                                                                                          long parentResourcePrimKey,
                                                                                          int status)

getKBArticleVersions

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<KBArticle> getKBArticleVersions(long resourcePrimKey,
                                                                                                                  int status,
                                                                                                                  int start,
                                                                                                                  int end,
                                                                                                                  com.liferay.portal.kernel.util.OrderByComparator<KBArticle> orderByComparator)

getKBArticleVersionsCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getKBArticleVersionsCount(long resourcePrimKey,
                                                                                                 int status)

getKBFolderKBArticles

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<KBArticle> getKBFolderKBArticles(long groupId,
                                                                                                                   long kbFolderId)

getKBFolderKBArticlesCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getKBFolderKBArticlesCount(long groupId,
                                                                                                  long kbFolderId,
                                                                                                  int status)

getLatestKBArticle

@Transactional(propagation=SUPPORTS,
               readOnly=true)
KBArticle getLatestKBArticle(long resourcePrimKey,
                                                                                                int status)
                                                                                         throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

getLatestKBArticleByUrlTitle

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

java.lang.String getOSGiServiceIdentifier()

Returns the OSGi service identifier.

Returns:

the OSGi service identifier

getPersistedModel

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<? extends com.liferay.portal.kernel.model.PersistedModel> getPersistedModel(long resourcePrimKey)
                                                                                                                                                       throws com.liferay.portal.kernel.exception.PortalException

Specified by:

getPersistedModel in interface com.liferay.portal.kernel.service.PersistedResourcedModelLocalService

Throws:

com.liferay.portal.kernel.exception.PortalException

getPersistedModel

@Transactional(propagation=SUPPORTS,
               readOnly=true)
com.liferay.portal.kernel.model.PersistedModel getPersistedModel(java.io.Serializable primaryKeyObj)
                                                                                                                             throws com.liferay.portal.kernel.exception.PortalException

Specified by:

getPersistedModel in interface com.liferay.portal.kernel.service.PersistedModelLocalService

Throws:

com.liferay.portal.kernel.exception.PortalException

getPreviousAndNextKBArticles

@Transactional(propagation=SUPPORTS,
               readOnly=true)
KBArticle[] getPreviousAndNextKBArticles(long kbArticleId)
                                                                                                     throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

getSectionsKBArticles

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getSectionsKBArticlesCount(long groupId,
                                                                                                  java.lang.String[] sections,
                                                                                                  int status)

getTempAttachmentNames

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
void incrementViewCount(long userId,
                                                                                           long resourcePrimKey,
                                                                                           int increment)
                                                                                    throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

moveKBArticle

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

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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

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

Throws:

com.liferay.portal.kernel.exception.PortalException

subscribeKBArticle

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

Throws:

com.liferay.portal.kernel.exception.PortalException

unsubscribeGroupKBArticles

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

Throws:

com.liferay.portal.kernel.exception.PortalException

unsubscribeKBArticle

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

Throws:

com.liferay.portal.kernel.exception.PortalException

updateKBArticle

@Indexable(type=REINDEX)
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

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

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

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

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

void updatePriority(long resourcePrimKey,
                    double priority)

updateStatus

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