com.liferay.message.boards.service.MBBanLocalService 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.message.boards.service;
import aQute.bnd.annotation.ProviderType;
import com.liferay.exportimport.kernel.lar.PortletDataContext;
import com.liferay.message.boards.model.MBBan;
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 MBBan. 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 MBBanLocalServiceUtil
* @generated
*/
@ProviderType
@Transactional(
isolation = Isolation.PORTAL,
rollbackFor = {PortalException.class, SystemException.class}
)
public interface MBBanLocalService
extends BaseLocalService, PersistedModelLocalService {
/*
* NOTE FOR DEVELOPERS:
*
* Never modify or reference this interface directly. Always use {@link MBBanLocalServiceUtil} to access the message boards ban local service. Add custom service methods to com.liferay.message.boards.service.impl.MBBanLocalServiceImpl and rerun ServiceBuilder to automatically copy the method declarations to this interface.
*/
public MBBan addBan(
long userId, long banUserId, ServiceContext serviceContext)
throws PortalException;
/**
* Adds the message boards ban to the database. Also notifies the appropriate model listeners.
*
* @param mbBan the message boards ban
* @return the message boards ban that was added
*/
@Indexable(type = IndexableType.REINDEX)
public MBBan addMBBan(MBBan mbBan);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public void checkBan(long groupId, long banUserId) throws PortalException;
/**
* Creates a new message boards ban with the primary key. Does not add the message boards ban to the database.
*
* @param banId the primary key for the new message boards ban
* @return the new message boards ban
*/
@Transactional(enabled = false)
public MBBan createMBBan(long banId);
public void deleteBan(long banId) throws PortalException;
public void deleteBan(long banUserId, ServiceContext serviceContext);
@SystemEvent(type = SystemEventConstants.TYPE_DELETE)
public void deleteBan(MBBan ban);
public void deleteBansByBanUserId(long banUserId);
public void deleteBansByGroupId(long groupId);
/**
* Deletes the message boards ban with the primary key from the database. Also notifies the appropriate model listeners.
*
* @param banId the primary key of the message boards ban
* @return the message boards ban that was removed
* @throws PortalException if a message boards ban with the primary key could not be found
*/
@Indexable(type = IndexableType.DELETE)
public MBBan deleteMBBan(long banId) throws PortalException;
/**
* Deletes the message boards ban from the database. Also notifies the appropriate model listeners.
*
* @param mbBan the message boards ban
* @return the message boards ban that was removed
*/
@Indexable(type = IndexableType.DELETE)
public MBBan deleteMBBan(MBBan mbBan);
/**
* @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.message.boards.model.impl.MBBanModelImpl. 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.message.boards.model.impl.MBBanModelImpl. 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);
public void expireBans();
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public MBBan fetchMBBan(long banId);
/**
* Returns the message boards ban matching the UUID and group.
*
* @param uuid the message boards ban's UUID
* @param groupId the primary key of the group
* @return the matching message boards ban, or null if a matching message boards ban could not be found
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public MBBan fetchMBBanByUuidAndGroupId(String uuid, long groupId);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public ActionableDynamicQuery getActionableDynamicQuery();
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List getBans(long groupId, int start, int end);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public int getBansCount(long groupId);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public ExportActionableDynamicQuery getExportActionableDynamicQuery(
PortletDataContext portletDataContext);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public IndexableActionableDynamicQuery getIndexableActionableDynamicQuery();
/**
* Returns the message boards ban with the primary key.
*
* @param banId the primary key of the message boards ban
* @return the message boards ban
* @throws PortalException if a message boards ban with the primary key could not be found
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public MBBan getMBBan(long banId) throws PortalException;
/**
* Returns the message boards ban matching the UUID and group.
*
* @param uuid the message boards ban's UUID
* @param groupId the primary key of the group
* @return the matching message boards ban
* @throws PortalException if a matching message boards ban could not be found
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public MBBan getMBBanByUuidAndGroupId(String uuid, long groupId)
throws PortalException;
/**
* Returns a range of all the message boards bans.
*
*
* 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.message.boards.model.impl.MBBanModelImpl. 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 message boards bans
* @param end the upper bound of the range of message boards bans (not inclusive)
* @return the range of message boards bans
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List getMBBans(int start, int end);
/**
* Returns all the message boards bans matching the UUID and company.
*
* @param uuid the UUID of the message boards bans
* @param companyId the primary key of the company
* @return the matching message boards bans, or an empty list if no matches were found
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List getMBBansByUuidAndCompanyId(String uuid, long companyId);
/**
* Returns a range of message boards bans matching the UUID and company.
*
* @param uuid the UUID of the message boards bans
* @param companyId the primary key of the company
* @param start the lower bound of the range of message boards bans
* @param end the upper bound of the range of message boards bans (not inclusive)
* @param orderByComparator the comparator to order the results by (optionally null)
* @return the range of matching message boards bans, or an empty list if no matches were found
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List getMBBansByUuidAndCompanyId(
String uuid, long companyId, int start, int end,
OrderByComparator orderByComparator);
/**
* Returns the number of message boards bans.
*
* @return the number of message boards bans
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public int getMBBansCount();
/**
* 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;
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public boolean hasBan(long groupId, long banUserId);
/**
* Updates the message boards ban in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
*
* @param mbBan the message boards ban
* @return the message boards ban that was updated
*/
@Indexable(type = IndexableType.REINDEX)
public MBBan updateMBBan(MBBan mbBan);
}