com.liferay.knowledge.base.service.KBCommentLocalService Maven / Gradle / Ivy
/**
* Copyright (c) 2000-present Liferay, Inc. All rights reserved.
*
* This library is free software; you can redistribute it and/or modify it under
* the terms of the GNU Lesser General Public License as published by the Free
* Software Foundation; either version 2.1 of the License, or (at your option)
* any later version.
*
* This library is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
* FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
* details.
*/
package com.liferay.knowledge.base.service;
import aQute.bnd.annotation.ProviderType;
import com.liferay.exportimport.kernel.lar.PortletDataContext;
import com.liferay.knowledge.base.model.KBComment;
import com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery;
import com.liferay.portal.kernel.dao.orm.DynamicQuery;
import com.liferay.portal.kernel.dao.orm.ExportActionableDynamicQuery;
import com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery;
import com.liferay.portal.kernel.dao.orm.Projection;
import com.liferay.portal.kernel.exception.PortalException;
import com.liferay.portal.kernel.exception.SystemException;
import com.liferay.portal.kernel.model.PersistedModel;
import com.liferay.portal.kernel.model.SystemEventConstants;
import com.liferay.portal.kernel.search.Indexable;
import com.liferay.portal.kernel.search.IndexableType;
import com.liferay.portal.kernel.service.BaseLocalService;
import com.liferay.portal.kernel.service.PersistedModelLocalService;
import com.liferay.portal.kernel.service.ServiceContext;
import com.liferay.portal.kernel.systemevent.SystemEvent;
import com.liferay.portal.kernel.transaction.Isolation;
import com.liferay.portal.kernel.transaction.Propagation;
import com.liferay.portal.kernel.transaction.Transactional;
import com.liferay.portal.kernel.util.OrderByComparator;
import java.io.Serializable;
import java.util.List;
/**
* Provides the local service interface for KBComment. 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.
*
* @author Brian Wing Shun Chan
* @see KBCommentLocalServiceUtil
* @generated
*/
@ProviderType
@Transactional(
isolation = Isolation.PORTAL,
rollbackFor = {PortalException.class, SystemException.class}
)
public interface KBCommentLocalService
extends BaseLocalService, PersistedModelLocalService {
/*
* NOTE FOR DEVELOPERS:
*
* Never modify or reference this interface directly. Always use {@link KBCommentLocalServiceUtil} to access the kb comment local service. Add custom service methods to com.liferay.knowledge.base.service.impl.KBCommentLocalServiceImpl and rerun ServiceBuilder to automatically copy the method declarations to this interface.
*/
/**
* Adds the kb comment to the database. Also notifies the appropriate model listeners.
*
* @param kbComment the kb comment
* @return the kb comment that was added
*/
@Indexable(type = IndexableType.REINDEX)
public KBComment addKBComment(KBComment kbComment);
public KBComment addKBComment(
long userId, long classNameId, long classPK, String content,
int userRating, ServiceContext serviceContext)
throws PortalException;
public KBComment addKBComment(
long userId, long classNameId, long classPK, String content,
ServiceContext serviceContext)
throws PortalException;
/**
* Creates a new kb comment with the primary key. Does not add the kb comment to the database.
*
* @param kbCommentId the primary key for the new kb comment
* @return the new kb comment
*/
@Transactional(enabled = false)
public KBComment createKBComment(long kbCommentId);
/**
* Deletes the kb comment from the database. Also notifies the appropriate model listeners.
*
* @param kbComment the kb comment
* @return the kb comment that was removed
* @throws PortalException
*/
@Indexable(type = IndexableType.DELETE)
@SystemEvent(type = SystemEventConstants.TYPE_DELETE)
public KBComment deleteKBComment(KBComment kbComment)
throws PortalException;
/**
* Deletes the kb comment with the primary key from the database. Also notifies the appropriate model listeners.
*
* @param kbCommentId the primary key of the kb comment
* @return the kb comment that was removed
* @throws PortalException if a kb comment with the primary key could not be found
*/
@Indexable(type = IndexableType.DELETE)
public KBComment deleteKBComment(long kbCommentId) throws PortalException;
public void deleteKBComments(String className, long classPK)
throws PortalException;
/**
* @throws PortalException
*/
@Override
public PersistedModel deletePersistedModel(PersistedModel persistedModel)
throws PortalException;
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public DynamicQuery dynamicQuery();
/**
* Performs a dynamic query on the database and returns the matching rows.
*
* @param dynamicQuery the dynamic query
* @return the matching rows
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List dynamicQuery(DynamicQuery dynamicQuery);
/**
* 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 and pagination is required (start and end are not com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS), then the query will include the default ORDER BY logic from com.liferay.knowledge.base.model.impl.KBCommentModelImpl. If both orderByComparator and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.
*
*
* @param dynamicQuery the dynamic query
* @param start the lower bound of the range of model instances
* @param end the upper bound of the range of model instances (not inclusive)
* @return the range of matching rows
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List dynamicQuery(
DynamicQuery dynamicQuery, int start, int end);
/**
* 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 and pagination is required (start and end are not com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS), then the query will include the default ORDER BY logic from com.liferay.knowledge.base.model.impl.KBCommentModelImpl. If both orderByComparator and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.
*
*
* @param dynamicQuery the dynamic query
* @param start the lower bound of the range of model instances
* @param end the upper bound of the range of model instances (not inclusive)
* @param orderByComparator the comparator to order the results by (optionally null)
* @return the ordered range of matching rows
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List dynamicQuery(
DynamicQuery dynamicQuery, int start, int end,
OrderByComparator orderByComparator);
/**
* Returns the number of rows matching the dynamic query.
*
* @param dynamicQuery the dynamic query
* @return the number of rows matching the dynamic query
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public long dynamicQueryCount(DynamicQuery dynamicQuery);
/**
* Returns the number of rows matching the dynamic query.
*
* @param dynamicQuery the dynamic query
* @param projection the projection to apply to the query
* @return the number of rows matching the dynamic query
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public long dynamicQueryCount(
DynamicQuery dynamicQuery, Projection projection);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public KBComment fetchKBComment(long kbCommentId);
/**
* Returns the kb comment matching the UUID and group.
*
* @param uuid the kb comment's UUID
* @param groupId the primary key of the group
* @return the matching kb comment, or null if a matching kb comment could not be found
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public KBComment fetchKBCommentByUuidAndGroupId(String uuid, long groupId);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public ActionableDynamicQuery getActionableDynamicQuery();
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public ExportActionableDynamicQuery getExportActionableDynamicQuery(
PortletDataContext portletDataContext);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public IndexableActionableDynamicQuery getIndexableActionableDynamicQuery();
/**
* Returns the kb comment with the primary key.
*
* @param kbCommentId the primary key of the kb comment
* @return the kb comment
* @throws PortalException if a kb comment with the primary key could not be found
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public KBComment getKBComment(long kbCommentId) throws PortalException;
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public KBComment getKBComment(long userId, String className, long classPK)
throws PortalException;
/**
* Returns the kb comment matching the UUID and group.
*
* @param uuid the kb comment's UUID
* @param groupId the primary key of the group
* @return the matching kb comment
* @throws PortalException if a matching kb comment could not be found
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public KBComment getKBCommentByUuidAndGroupId(String uuid, long groupId)
throws PortalException;
/**
* Returns a range of all the kb comments.
*
*
* 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 and pagination is required (start and end are not com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS), then the query will include the default ORDER BY logic from com.liferay.knowledge.base.model.impl.KBCommentModelImpl. If both orderByComparator and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.
*
*
* @param start the lower bound of the range of kb comments
* @param end the upper bound of the range of kb comments (not inclusive)
* @return the range of kb comments
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List getKBComments(int start, int end);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List getKBComments(
long groupId, int status, int start, int end);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List getKBComments(
long groupId, int status, int start, int end,
OrderByComparator obc);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List getKBComments(
long groupId, int start, int end, OrderByComparator obc);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List getKBComments(
long userId, String className, long classPK, int start, int end,
OrderByComparator orderByComparator);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List getKBComments(
String className, long classPK, int status, int start, int end);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List getKBComments(
String className, long classPK, int status, int start, int end,
OrderByComparator obc);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List getKBComments(
String className, long classPK, int start, int end,
OrderByComparator orderByComparator);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List getKBComments(
String className, long classPK, int[] status, int start, int end);
/**
* Returns all the kb comments matching the UUID and company.
*
* @param uuid the UUID of the kb comments
* @param companyId the primary key of the company
* @return the matching kb comments, or an empty list if no matches were found
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List getKBCommentsByUuidAndCompanyId(
String uuid, long companyId);
/**
* Returns a range of kb comments matching the UUID and company.
*
* @param uuid the UUID of the kb comments
* @param companyId the primary key of the company
* @param start the lower bound of the range of kb comments
* @param end the upper bound of the range of kb comments (not inclusive)
* @param orderByComparator the comparator to order the results by (optionally null)
* @return the range of matching kb comments, or an empty list if no matches were found
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List getKBCommentsByUuidAndCompanyId(
String uuid, long companyId, int start, int end,
OrderByComparator orderByComparator);
/**
* Returns the number of kb comments.
*
* @return the number of kb comments
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public int getKBCommentsCount();
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public int getKBCommentsCount(long groupId, int status);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public int getKBCommentsCount(long userId, String className, long classPK);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public int getKBCommentsCount(String className, long classPK);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public int getKBCommentsCount(String className, long classPK, int status);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public int getKBCommentsCount(String className, long classPK, int[] status);
/**
* Returns the OSGi service identifier.
*
* @return the OSGi service identifier
*/
public String getOSGiServiceIdentifier();
@Override
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public PersistedModel getPersistedModel(Serializable primaryKeyObj)
throws PortalException;
/**
* Updates the kb comment in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
*
* @param kbComment the kb comment
* @return the kb comment that was updated
*/
@Indexable(type = IndexableType.REINDEX)
public KBComment updateKBComment(KBComment kbComment);
public KBComment updateKBComment(
long kbCommentId, long classNameId, long classPK, String content,
int userRating, int status, ServiceContext serviceContext)
throws PortalException;
public KBComment updateKBComment(
long kbCommentId, long classNameId, long classPK, String content,
int status, ServiceContext serviceContext)
throws PortalException;
public KBComment updateStatus(
long userId, long kbCommentId, int status,
ServiceContext serviceContext)
throws PortalException;
}