Interface KBArticleService
- All Superinterfaces:
com.liferay.portal.kernel.service.BaseService
- All Known Implementing Classes:
KBArticleServiceWrapper
@AccessControlled
@CTAware
@JSONWebService
@ProviderType
@Transactional(isolation=PORTAL,
rollbackFor={com.liferay.portal.kernel.exception.PortalException.class,com.liferay.portal.kernel.exception.SystemException.class})
public interface KBArticleService
extends com.liferay.portal.kernel.service.BaseService
Provides the remote service interface for KBArticle. Methods of this
service are expected to have security checks based on the propagated JAAS
credentials because this service can be accessed remotely.
- See Also:
- Generated:
-
Method Summary
Modifier and TypeMethodDescriptionaddKBArticle
(String externalReferenceCode, String portletId, long parentResourceClassNameId, long parentResourcePrimKey, String title, String urlTitle, String content, String description, String[] sections, String sourceURL, Date displayDate, Date expirationDate, Date reviewDate, String[] selectedFileNames, com.liferay.portal.kernel.service.ServiceContext serviceContext) int
addKBArticlesMarkdown
(long groupId, long parentKBFolderId, String fileName, boolean prioritizeByNumericalPrefix, InputStream inputStream, com.liferay.portal.kernel.service.ServiceContext serviceContext) void
addTempAttachment
(long groupId, long resourcePrimKey, String fileName, String tempFolderName, InputStream inputStream, String mimeType) int
countKBArticlesByKeywords
(long groupId, String keywords, int status) deleteKBArticle
(long resourcePrimKey) void
deleteKBArticles
(long groupId, long[] resourcePrimKeys) void
deleteTempAttachment
(long groupId, long resourcePrimKey, String fileName, String tempFolderName) expireKBArticle
(long resourcePrimKey, com.liferay.portal.kernel.service.ServiceContext serviceContext) fetchFirstChildKBArticle
(long groupId, long parentResourcePrimKey) fetchFirstChildKBArticle
(long groupId, long parentResourcePrimKey, int status) fetchKBArticleByUrlTitle
(long groupId, long kbFolderId, String urlTitle) fetchLatestKBArticle
(long resourcePrimKey, int status) fetchLatestKBArticleByExternalReferenceCode
(long groupId, String externalReferenceCode) fetchLatestKBArticleByUrlTitle
(long groupId, long kbFolderId, String urlTitle, int status) com.liferay.portal.kernel.lock.Lock
forceLockKBArticle
(long groupId, long resourcePrimKey) getAllDescendantKBArticles
(long groupId, long resourcePrimKey, int status, com.liferay.portal.kernel.util.OrderByComparator<KBArticle> orderByComparator) getGroupKBArticles
(long groupId, int status, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<KBArticle> orderByComparator) int
getGroupKBArticlesCount
(long groupId, int status) getGroupKBArticlesRSS
(int status, int max, String type, double version, String displayStyle, com.liferay.portal.kernel.theme.ThemeDisplay themeDisplay) getKBArticle
(long resourcePrimKey, int version) getKBArticleAndAllDescendantKBArticles
(long resourcePrimKey, int status, com.liferay.portal.kernel.util.OrderByComparator<KBArticle> orderByComparator) getKBArticleRSS
(long resourcePrimKey, int status, int max, String type, double version, String displayStyle, com.liferay.portal.kernel.theme.ThemeDisplay themeDisplay) getKBArticles
(long groupId, long[] resourcePrimKeys, int status, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<KBArticle> orderByComparator) getKBArticles
(long groupId, long[] resourcePrimKeys, int status, com.liferay.portal.kernel.util.OrderByComparator<KBArticle> orderByComparator) getKBArticles
(long groupId, long parentResourcePrimKey, int status, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<KBArticle> orderByComparator) getKBArticlesByKeywords
(long groupId, String keywords, int status, int start, int end) int
getKBArticlesCount
(long groupId, long[] resourcePrimKeys, int status) int
getKBArticlesCount
(long groupId, long parentResourcePrimKey, int status) getKBArticleSearchDisplay
(long groupId, String title, String content, int status, Date startDate, Date endDate, boolean andOperator, int[] curStartValues, int cur, int delta, com.liferay.portal.kernel.util.OrderByComparator<KBArticle> orderByComparator) getKBArticleVersions
(long groupId, long resourcePrimKey, int status, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<KBArticle> orderByComparator) int
getKBArticleVersionsCount
(long groupId, long resourcePrimKey, int status) getLatestKBArticle
(long resourcePrimKey) getLatestKBArticle
(long resourcePrimKey, int status) getLatestKBArticleByExternalReferenceCode
(long groupId, String externalReferenceCode) Returns the OSGi service identifier.getPreviousAndNextKBArticles
(long kbArticleId) getSectionsKBArticles
(long groupId, String[] sections, int status, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<KBArticle> orderByComparator) int
getSectionsKBArticlesCount
(long groupId, String[] sections, int status) String[]
getTempAttachmentNames
(long groupId, String tempFolderName) com.liferay.portal.kernel.lock.Lock
lockKBArticle
(long resourcePrimKey) void
moveKBArticle
(long resourcePrimKey, long parentResourceClassNameId, long parentResourcePrimKey, double priority) moveKBArticleToTrash
(long resourcePrimKey) revertKBArticle
(long resourcePrimKey, int version, com.liferay.portal.kernel.service.ServiceContext serviceContext) void
subscribeGroupKBArticles
(long groupId, String portletId) void
subscribeKBArticle
(long groupId, long resourcePrimKey) void
unlockKBArticle
(long resourcePrimKey) void
unsubscribeGroupKBArticles
(long groupId, String portletId) void
unsubscribeKBArticle
(long resourcePrimKey) updateAndUnlockKBArticle
(long resourcePrimKey, String title, String content, String description, String[] sections, String sourceURL, Date displayDate, Date expirationDate, Date reviewDate, String[] selectedFileNames, long[] removeFileEntryIds, com.liferay.portal.kernel.service.ServiceContext serviceContext) updateKBArticle
(long resourcePrimKey, String title, String content, String description, String[] sections, String sourceURL, Date displayDate, Date expirationDate, Date reviewDate, String[] selectedFileNames, long[] removeFileEntryIds, com.liferay.portal.kernel.service.ServiceContext serviceContext) void
updateKBArticlesPriorities
(long groupId, Map<Long, Double> resourcePrimKeyToPriorityMap)
-
Method Details
-
addKBArticle
KBArticle addKBArticle(String externalReferenceCode, String portletId, long parentResourceClassNameId, long parentResourcePrimKey, String title, String urlTitle, String content, String description, String[] sections, String sourceURL, Date displayDate, Date expirationDate, Date reviewDate, String[] selectedFileNames, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
addKBArticlesMarkdown
int addKBArticlesMarkdown(long groupId, long parentKBFolderId, String fileName, boolean prioritizeByNumericalPrefix, 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 resourcePrimKey, String fileName, String tempFolderName, InputStream inputStream, String mimeType) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
countKBArticlesByKeywords
-
deleteKBArticle
KBArticle deleteKBArticle(long resourcePrimKey) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
deleteKBArticles
void deleteKBArticles(long groupId, long[] resourcePrimKeys) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
deleteTempAttachment
void deleteTempAttachment(long groupId, long resourcePrimKey, String fileName, String tempFolderName) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
expireKBArticle
KBArticle expireKBArticle(long resourcePrimKey, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
fetchFirstChildKBArticle
@Transactional(propagation=SUPPORTS, readOnly=true) KBArticle fetchFirstChildKBArticle(long groupId, long parentResourcePrimKey) -
fetchFirstChildKBArticle
@Transactional(propagation=SUPPORTS, readOnly=true) KBArticle fetchFirstChildKBArticle(long groupId, long parentResourcePrimKey, int status) -
fetchKBArticleByUrlTitle
@Transactional(propagation=SUPPORTS, readOnly=true) KBArticle fetchKBArticleByUrlTitle(long groupId, long kbFolderId, String urlTitle) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
fetchLatestKBArticle
@Transactional(propagation=SUPPORTS, readOnly=true) KBArticle fetchLatestKBArticle(long resourcePrimKey, int status) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
fetchLatestKBArticleByExternalReferenceCode
@Transactional(propagation=SUPPORTS, readOnly=true) KBArticle fetchLatestKBArticleByExternalReferenceCode(long groupId, String externalReferenceCode) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
fetchLatestKBArticleByUrlTitle
@Transactional(propagation=SUPPORTS, readOnly=true) KBArticle fetchLatestKBArticleByUrlTitle(long groupId, long kbFolderId, String urlTitle, int status) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
forceLockKBArticle
com.liferay.portal.kernel.lock.Lock forceLockKBArticle(long groupId, long resourcePrimKey) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
getAllDescendantKBArticles
@Transactional(propagation=SUPPORTS, readOnly=true) List<KBArticle> getAllDescendantKBArticles(long groupId, long resourcePrimKey, int status, com.liferay.portal.kernel.util.OrderByComparator<KBArticle> orderByComparator) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
getGroupKBArticles
-
getGroupKBArticlesCount
@Transactional(propagation=SUPPORTS, readOnly=true) int getGroupKBArticlesCount(long groupId, int status) -
getGroupKBArticlesRSS
@Transactional(propagation=SUPPORTS, readOnly=true) String getGroupKBArticlesRSS(int status, int max, String type, double version, String displayStyle, com.liferay.portal.kernel.theme.ThemeDisplay themeDisplay) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
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) List<KBArticle> getKBArticleAndAllDescendantKBArticles(long resourcePrimKey, int status, com.liferay.portal.kernel.util.OrderByComparator<KBArticle> orderByComparator) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
getKBArticleRSS
@Transactional(propagation=SUPPORTS, readOnly=true) String getKBArticleRSS(long resourcePrimKey, int status, int max, String type, double version, String displayStyle, com.liferay.portal.kernel.theme.ThemeDisplay themeDisplay) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
getKBArticles
-
getKBArticles
-
getKBArticles
-
getKBArticlesByKeywords
-
getKBArticlesCount
@Transactional(propagation=SUPPORTS, readOnly=true) int getKBArticlesCount(long groupId, long parentResourcePrimKey, int status) -
getKBArticlesCount
@Transactional(propagation=SUPPORTS, readOnly=true) int getKBArticlesCount(long groupId, long[] resourcePrimKeys, int status) -
getKBArticleSearchDisplay
@Transactional(propagation=SUPPORTS, readOnly=true) KBArticleSearchDisplay getKBArticleSearchDisplay(long groupId, String title, String content, int status, Date startDate, Date endDate, boolean andOperator, int[] curStartValues, int cur, int delta, com.liferay.portal.kernel.util.OrderByComparator<KBArticle> orderByComparator) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
getKBArticleVersions
-
getKBArticleVersionsCount
@Transactional(propagation=SUPPORTS, readOnly=true) int getKBArticleVersionsCount(long groupId, long resourcePrimKey, int status) -
getLatestKBArticle
@Transactional(propagation=SUPPORTS, readOnly=true) KBArticle getLatestKBArticle(long resourcePrimKey) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
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
-
getLatestKBArticleByExternalReferenceCode
@Transactional(propagation=SUPPORTS, readOnly=true) KBArticle getLatestKBArticleByExternalReferenceCode(long groupId, String externalReferenceCode) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
getOSGiServiceIdentifier
String getOSGiServiceIdentifier()Returns the OSGi service identifier.- Returns:
- the OSGi service identifier
-
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
-
getSectionsKBArticlesCount
@Transactional(propagation=SUPPORTS, readOnly=true) int getSectionsKBArticlesCount(long groupId, String[] sections, int status) -
getTempAttachmentNames
@Transactional(propagation=SUPPORTS, readOnly=true) String[] getTempAttachmentNames(long groupId, String tempFolderName) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
lockKBArticle
com.liferay.portal.kernel.lock.Lock lockKBArticle(long resourcePrimKey) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
moveKBArticle
void moveKBArticle(long resourcePrimKey, long parentResourceClassNameId, long parentResourcePrimKey, double priority) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
moveKBArticleToTrash
KBArticle moveKBArticleToTrash(long resourcePrimKey) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
revertKBArticle
KBArticle revertKBArticle(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
-
subscribeGroupKBArticles
void subscribeGroupKBArticles(long groupId, String portletId) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
subscribeKBArticle
void subscribeKBArticle(long groupId, long resourcePrimKey) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
unlockKBArticle
void unlockKBArticle(long resourcePrimKey) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
unsubscribeGroupKBArticles
void unsubscribeGroupKBArticles(long groupId, String portletId) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
unsubscribeKBArticle
void unsubscribeKBArticle(long resourcePrimKey) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
updateAndUnlockKBArticle
KBArticle updateAndUnlockKBArticle(long resourcePrimKey, String title, String content, String description, String[] sections, String sourceURL, Date displayDate, Date expirationDate, Date reviewDate, String[] selectedFileNames, long[] removeFileEntryIds, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
updateKBArticle
KBArticle updateKBArticle(long resourcePrimKey, String title, String content, String description, String[] sections, String sourceURL, Date displayDate, Date expirationDate, Date reviewDate, String[] selectedFileNames, long[] removeFileEntryIds, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException - Throws:
com.liferay.portal.kernel.exception.PortalException
-
updateKBArticlesPriorities
void updateKBArticlesPriorities(long groupId, Map<Long, Double> resourcePrimKeyToPriorityMap) throws com.liferay.portal.kernel.exception.PortalException- Throws:
com.liferay.portal.kernel.exception.PortalException
-