Liferay 6.2-ce-ga5

com.liferay.portlet.messageboards.service
Class MBBanLocalServiceUtil

java.lang.Object
  extended by com.liferay.portlet.messageboards.service.MBBanLocalServiceUtil

@ProviderType
public class MBBanLocalServiceUtil
extends Object

Provides the local service utility for MBBan. This utility wraps com.liferay.portlet.messageboards.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.

See Also:
MBBanLocalService, com.liferay.portlet.messageboards.service.base.MBBanLocalServiceBaseImpl, com.liferay.portlet.messageboards.service.impl.MBBanLocalServiceImpl

Constructor Summary
MBBanLocalServiceUtil()
           
 
Method Summary
static MBBan addBan(long userId, long banUserId, ServiceContext serviceContext)
           
static MBBan addMBBan(MBBan mbBan)
          Adds the message boards ban to the database.
static void checkBan(long groupId, long banUserId)
           
static MBBan createMBBan(long banId)
          Creates a new message boards ban with the primary key.
static void deleteBan(long banId)
           
static void deleteBan(long banUserId, ServiceContext serviceContext)
           
static void deleteBan(MBBan ban)
           
static void deleteBansByBanUserId(long banUserId)
           
static void deleteBansByGroupId(long groupId)
           
static MBBan deleteMBBan(long banId)
          Deletes the message boards ban with the primary key from the database.
static MBBan deleteMBBan(MBBan mbBan)
          Deletes the message boards ban from the database.
static DynamicQuery dynamicQuery()
           
static List dynamicQuery(DynamicQuery dynamicQuery)
          Performs a dynamic query on the database and returns the matching rows.
static List dynamicQuery(DynamicQuery dynamicQuery, int start, int end)
          Performs a dynamic query on the database and returns a range of the matching rows.
static List dynamicQuery(DynamicQuery dynamicQuery, int start, int end, OrderByComparator orderByComparator)
          Performs a dynamic query on the database and returns an ordered range of the matching rows.
static long dynamicQueryCount(DynamicQuery dynamicQuery)
          Returns the number of rows that match the dynamic query.
static long dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection)
          Returns the number of rows that match the dynamic query.
static void expireBans()
           
static MBBan fetchMBBan(long banId)
           
static MBBan fetchMBBanByUuidAndCompanyId(String uuid, long companyId)
          Returns the message boards ban with the matching UUID and company.
static MBBan fetchMBBanByUuidAndGroupId(String uuid, long groupId)
          Returns the message boards ban matching the UUID and group.
static List<MBBan> getBans(long groupId, int start, int end)
           
static int getBansCount(long groupId)
           
static String getBeanIdentifier()
          Returns the Spring bean ID for this bean.
static MBBan getMBBan(long banId)
          Returns the message boards ban with the primary key.
static MBBan getMBBanByUuidAndCompanyId(String uuid, long companyId)
          Returns the message boards ban with the matching UUID and company.
static MBBan getMBBanByUuidAndGroupId(String uuid, long groupId)
          Returns the message boards ban matching the UUID and group.
static List<MBBan> getMBBans(int start, int end)
          Returns a range of all the message boards bans.
static int getMBBansCount()
          Returns the number of message boards bans.
static PersistedModel getPersistedModel(Serializable primaryKeyObj)
           
static MBBanLocalService getService()
           
static boolean hasBan(long groupId, long banUserId)
           
static void setBeanIdentifier(String beanIdentifier)
          Sets the Spring bean ID for this bean.
 void setService(MBBanLocalService service)
          Deprecated. As of 6.2.0
static MBBan updateMBBan(MBBan mbBan)
          Updates the message boards ban in the database or adds it if it does not yet exist.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

MBBanLocalServiceUtil

public MBBanLocalServiceUtil()
Method Detail

addMBBan

public static MBBan addMBBan(MBBan mbBan)
                      throws SystemException
Adds the message boards ban to the database. Also notifies the appropriate model listeners.

Parameters:
mbBan - the message boards ban
Returns:
the message boards ban that was added
Throws:
SystemException - if a system exception occurred

createMBBan

public static MBBan createMBBan(long banId)
Creates a new message boards ban with the primary key. Does not add the message boards ban to the database.

Parameters:
banId - the primary key for the new message boards ban
Returns:
the new message boards ban

deleteMBBan

public static MBBan deleteMBBan(long banId)
                         throws PortalException,
                                SystemException
Deletes the message boards ban with the primary key from the database. Also notifies the appropriate model listeners.

Parameters:
banId - the primary key of the message boards ban
Returns:
the message boards ban that was removed
Throws:
PortalException - if a message boards ban with the primary key could not be found
SystemException - if a system exception occurred

deleteMBBan

public static MBBan deleteMBBan(MBBan mbBan)
                         throws SystemException
Deletes the message boards ban from the database. Also notifies the appropriate model listeners.

Parameters:
mbBan - the message boards ban
Returns:
the message boards ban that was removed
Throws:
SystemException - if a system exception occurred

dynamicQuery

public static DynamicQuery dynamicQuery()

dynamicQuery

public static List dynamicQuery(DynamicQuery dynamicQuery)
                         throws SystemException
Performs a dynamic query on the database and returns the matching rows.

Parameters:
dynamicQuery - the dynamic query
Returns:
the matching rows
Throws:
SystemException - if a system exception occurred

dynamicQuery

public static List dynamicQuery(DynamicQuery dynamicQuery,
                                int start,
                                int end)
                         throws SystemException
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 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 QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from 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.

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
Throws:
SystemException - if a system exception occurred

dynamicQuery

public static List dynamicQuery(DynamicQuery dynamicQuery,
                                int start,
                                int end,
                                OrderByComparator orderByComparator)
                         throws SystemException
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 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 QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from 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.

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
Throws:
SystemException - if a system exception occurred

dynamicQueryCount

public static long dynamicQueryCount(DynamicQuery dynamicQuery)
                              throws SystemException
Returns the number of rows that match the dynamic query.

Parameters:
dynamicQuery - the dynamic query
Returns:
the number of rows that match the dynamic query
Throws:
SystemException - if a system exception occurred

dynamicQueryCount

public static long dynamicQueryCount(DynamicQuery dynamicQuery,
                                     Projection projection)
                              throws SystemException
Returns the number of rows that match the dynamic query.

Parameters:
dynamicQuery - the dynamic query
projection - the projection to apply to the query
Returns:
the number of rows that match the dynamic query
Throws:
SystemException - if a system exception occurred

fetchMBBan

public static MBBan fetchMBBan(long banId)
                        throws SystemException
Throws:
SystemException

fetchMBBanByUuidAndCompanyId

public static MBBan fetchMBBanByUuidAndCompanyId(String uuid,
                                                 long companyId)
                                          throws SystemException
Returns the message boards ban with the matching UUID and company.

Parameters:
uuid - the message boards ban's UUID
companyId - the primary key of the company
Returns:
the matching message boards ban, or null if a matching message boards ban could not be found
Throws:
SystemException - if a system exception occurred

fetchMBBanByUuidAndGroupId

public static MBBan fetchMBBanByUuidAndGroupId(String uuid,
                                               long groupId)
                                        throws SystemException
Returns the message boards ban matching the UUID and group.

Parameters:
uuid - the message boards ban's UUID
groupId - the primary key of the group
Returns:
the matching message boards ban, or null if a matching message boards ban could not be found
Throws:
SystemException - if a system exception occurred

getMBBan

public static MBBan getMBBan(long banId)
                      throws PortalException,
                             SystemException
Returns the message boards ban with the primary key.

Parameters:
banId - the primary key of the message boards ban
Returns:
the message boards ban
Throws:
PortalException - if a message boards ban with the primary key could not be found
SystemException - if a system exception occurred

getPersistedModel

public static PersistedModel getPersistedModel(Serializable primaryKeyObj)
                                        throws PortalException,
                                               SystemException
Throws:
PortalException
SystemException

getMBBanByUuidAndCompanyId

public static MBBan getMBBanByUuidAndCompanyId(String uuid,
                                               long companyId)
                                        throws PortalException,
                                               SystemException
Returns the message boards ban with the matching UUID and company.

Parameters:
uuid - the message boards ban's UUID
companyId - the primary key of the company
Returns:
the matching message boards ban
Throws:
PortalException - if a matching message boards ban could not be found
SystemException - if a system exception occurred

getMBBanByUuidAndGroupId

public static MBBan getMBBanByUuidAndGroupId(String uuid,
                                             long groupId)
                                      throws PortalException,
                                             SystemException
Returns the message boards ban matching the UUID and group.

Parameters:
uuid - the message boards ban's UUID
groupId - the primary key of the group
Returns:
the matching message boards ban
Throws:
PortalException - if a matching message boards ban could not be found
SystemException - if a system exception occurred

getMBBans

public static List<MBBan> getMBBans(int start,
                                    int end)
                             throws SystemException
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 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 QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from 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.

Parameters:
start - the lower bound of the range of message boards bans
end - the upper bound of the range of message boards bans (not inclusive)
Returns:
the range of message boards bans
Throws:
SystemException - if a system exception occurred

getMBBansCount

public static int getMBBansCount()
                          throws SystemException
Returns the number of message boards bans.

Returns:
the number of message boards bans
Throws:
SystemException - if a system exception occurred

updateMBBan

public static MBBan updateMBBan(MBBan mbBan)
                         throws SystemException
Updates the message boards ban in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

Parameters:
mbBan - the message boards ban
Returns:
the message boards ban that was updated
Throws:
SystemException - if a system exception occurred

getBeanIdentifier

public static String getBeanIdentifier()
Returns the Spring bean ID for this bean.

Returns:
the Spring bean ID for this bean

setBeanIdentifier

public static void setBeanIdentifier(String beanIdentifier)
Sets the Spring bean ID for this bean.

Parameters:
beanIdentifier - the Spring bean ID for this bean

addBan

public static MBBan addBan(long userId,
                           long banUserId,
                           ServiceContext serviceContext)
                    throws PortalException,
                           SystemException
Throws:
PortalException
SystemException

checkBan

public static void checkBan(long groupId,
                            long banUserId)
                     throws PortalException,
                            SystemException
Throws:
PortalException
SystemException

deleteBan

public static void deleteBan(long banId)
                      throws PortalException,
                             SystemException
Throws:
PortalException
SystemException

deleteBan

public static void deleteBan(long banUserId,
                             ServiceContext serviceContext)
                      throws SystemException
Throws:
SystemException

deleteBan

public static void deleteBan(MBBan ban)
                      throws SystemException
Throws:
SystemException

deleteBansByBanUserId

public static void deleteBansByBanUserId(long banUserId)
                                  throws SystemException
Throws:
SystemException

deleteBansByGroupId

public static void deleteBansByGroupId(long groupId)
                                throws SystemException
Throws:
SystemException

expireBans

public static void expireBans()
                       throws SystemException
Throws:
SystemException

getBans

public static List<MBBan> getBans(long groupId,
                                  int start,
                                  int end)
                           throws SystemException
Throws:
SystemException

getBansCount

public static int getBansCount(long groupId)
                        throws SystemException
Throws:
SystemException

hasBan

public static boolean hasBan(long groupId,
                             long banUserId)
                      throws SystemException
Throws:
SystemException

getService

public static MBBanLocalService getService()

setService

public void setService(MBBanLocalService service)
Deprecated. As of 6.2.0


Liferay 6.2-ce-ga5