com.liferay.message.boards.service.MBBanLocalServiceUtil Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of release.portal.api Show documentation
Show all versions of release.portal.api Show documentation
POM was created by Sonatype Nexus
/**
* 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 org.osgi.framework.Bundle;
import org.osgi.framework.FrameworkUtil;
import org.osgi.util.tracker.ServiceTracker;
/**
* Provides the local service utility for MBBan. This utility wraps
* {@link com.liferay.message.boards.service.impl.MBBanLocalServiceImpl} and is the
* primary access point for service operations in application layer code running
* on the local server. Methods of this service will not have security checks
* based on the propagated JAAS credentials because this service can only be
* accessed from within the same VM.
*
* @author Brian Wing Shun Chan
* @see MBBanLocalService
* @see com.liferay.message.boards.service.base.MBBanLocalServiceBaseImpl
* @see com.liferay.message.boards.service.impl.MBBanLocalServiceImpl
* @generated
*/
@ProviderType
public class MBBanLocalServiceUtil {
/*
* NOTE FOR DEVELOPERS:
*
* Never modify this class directly. Add custom service methods to {@link com.liferay.message.boards.service.impl.MBBanLocalServiceImpl} and rerun ServiceBuilder to regenerate this class.
*/
public static com.liferay.message.boards.model.MBBan addBan(long userId,
long banUserId,
com.liferay.portal.kernel.service.ServiceContext serviceContext)
throws com.liferay.portal.kernel.exception.PortalException {
return getService().addBan(userId, banUserId, serviceContext);
}
/**
* 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
*/
public static com.liferay.message.boards.model.MBBan addMBBan(
com.liferay.message.boards.model.MBBan mbBan) {
return getService().addMBBan(mbBan);
}
public static void checkBan(long groupId, long banUserId)
throws com.liferay.portal.kernel.exception.PortalException {
getService().checkBan(groupId, banUserId);
}
/**
* 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
*/
public static com.liferay.message.boards.model.MBBan createMBBan(long banId) {
return getService().createMBBan(banId);
}
public static void deleteBan(long banId)
throws com.liferay.portal.kernel.exception.PortalException {
getService().deleteBan(banId);
}
public static void deleteBan(long banUserId,
com.liferay.portal.kernel.service.ServiceContext serviceContext) {
getService().deleteBan(banUserId, serviceContext);
}
public static void deleteBan(com.liferay.message.boards.model.MBBan ban) {
getService().deleteBan(ban);
}
public static void deleteBansByBanUserId(long banUserId) {
getService().deleteBansByBanUserId(banUserId);
}
public static void deleteBansByGroupId(long groupId) {
getService().deleteBansByGroupId(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
*/
public static com.liferay.message.boards.model.MBBan deleteMBBan(long banId)
throws com.liferay.portal.kernel.exception.PortalException {
return getService().deleteMBBan(banId);
}
/**
* 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
*/
public static com.liferay.message.boards.model.MBBan deleteMBBan(
com.liferay.message.boards.model.MBBan mbBan) {
return getService().deleteMBBan(mbBan);
}
/**
* @throws PortalException
*/
public static com.liferay.portal.kernel.model.PersistedModel deletePersistedModel(
com.liferay.portal.kernel.model.PersistedModel persistedModel)
throws com.liferay.portal.kernel.exception.PortalException {
return getService().deletePersistedModel(persistedModel);
}
public static com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery() {
return getService().dynamicQuery();
}
/**
* Performs a dynamic query on the database and returns the matching rows.
*
* @param dynamicQuery the dynamic query
* @return the matching rows
*/
public static java.util.List dynamicQuery(
com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) {
return getService().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 {@link 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 {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link 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
*/
public static java.util.List dynamicQuery(
com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
int end) {
return getService().dynamicQuery(dynamicQuery, start, 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 {@link 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 {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link 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
*/
public static java.util.List dynamicQuery(
com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
int end,
com.liferay.portal.kernel.util.OrderByComparator orderByComparator) {
return getService()
.dynamicQuery(dynamicQuery, start, end, orderByComparator);
}
/**
* Returns the number of rows matching the dynamic query.
*
* @param dynamicQuery the dynamic query
* @return the number of rows matching the dynamic query
*/
public static long dynamicQueryCount(
com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) {
return getService().dynamicQueryCount(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
*/
public static long dynamicQueryCount(
com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery,
com.liferay.portal.kernel.dao.orm.Projection projection) {
return getService().dynamicQueryCount(dynamicQuery, projection);
}
public static void expireBans() {
getService().expireBans();
}
public static com.liferay.message.boards.model.MBBan fetchMBBan(long banId) {
return getService().fetchMBBan(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
*/
public static com.liferay.message.boards.model.MBBan fetchMBBanByUuidAndGroupId(
String uuid, long groupId) {
return getService().fetchMBBanByUuidAndGroupId(uuid, groupId);
}
public static com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery() {
return getService().getActionableDynamicQuery();
}
public static java.util.List getBans(
long groupId, int start, int end) {
return getService().getBans(groupId, start, end);
}
public static int getBansCount(long groupId) {
return getService().getBansCount(groupId);
}
public static com.liferay.portal.kernel.dao.orm.ExportActionableDynamicQuery getExportActionableDynamicQuery(
com.liferay.exportimport.kernel.lar.PortletDataContext portletDataContext) {
return getService().getExportActionableDynamicQuery(portletDataContext);
}
public static com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery getIndexableActionableDynamicQuery() {
return getService().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
*/
public static com.liferay.message.boards.model.MBBan getMBBan(long banId)
throws com.liferay.portal.kernel.exception.PortalException {
return getService().getMBBan(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
* @throws PortalException if a matching message boards ban could not be found
*/
public static com.liferay.message.boards.model.MBBan getMBBanByUuidAndGroupId(
String uuid, long groupId)
throws com.liferay.portal.kernel.exception.PortalException {
return getService().getMBBanByUuidAndGroupId(uuid, groupId);
}
/**
* 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 {@link 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 {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link 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
*/
public static java.util.List getMBBans(
int start, int end) {
return getService().getMBBans(start, 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
*/
public static java.util.List getMBBansByUuidAndCompanyId(
String uuid, long companyId) {
return getService().getMBBansByUuidAndCompanyId(uuid, 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
*/
public static java.util.List getMBBansByUuidAndCompanyId(
String uuid, long companyId, int start, int end,
com.liferay.portal.kernel.util.OrderByComparator orderByComparator) {
return getService()
.getMBBansByUuidAndCompanyId(uuid, companyId, start, end,
orderByComparator);
}
/**
* Returns the number of message boards bans.
*
* @return the number of message boards bans
*/
public static int getMBBansCount() {
return getService().getMBBansCount();
}
/**
* Returns the OSGi service identifier.
*
* @return the OSGi service identifier
*/
public static String getOSGiServiceIdentifier() {
return getService().getOSGiServiceIdentifier();
}
public static com.liferay.portal.kernel.model.PersistedModel getPersistedModel(
java.io.Serializable primaryKeyObj)
throws com.liferay.portal.kernel.exception.PortalException {
return getService().getPersistedModel(primaryKeyObj);
}
public static boolean hasBan(long groupId, long banUserId) {
return getService().hasBan(groupId, 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
*/
public static com.liferay.message.boards.model.MBBan updateMBBan(
com.liferay.message.boards.model.MBBan mbBan) {
return getService().updateMBBan(mbBan);
}
public static MBBanLocalService getService() {
return _serviceTracker.getService();
}
private static ServiceTracker _serviceTracker;
static {
Bundle bundle = FrameworkUtil.getBundle(MBBanLocalService.class);
ServiceTracker serviceTracker = new ServiceTracker(bundle.getBundleContext(),
MBBanLocalService.class, null);
serviceTracker.open();
_serviceTracker = serviceTracker;
}
}