com.liferay.portlet.messageboards.service

Interface MBBanLocalService

All Superinterfaces:

BaseLocalService, PersistedModelLocalService

All Known Implementing Classes:

MBBanLocalServiceWrapper

@ProviderType
@Transactional(isolation=PORTAL,
               rollbackFor={PortalException.class,SystemException.class})
public interface MBBanLocalService
extends BaseLocalService, PersistedModelLocalService

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 Also:

MBBanLocalServiceUtil, com.liferay.portlet.messageboards.service.base.MBBanLocalServiceBaseImpl, com.liferay.portlet.messageboards.service.impl.MBBanLocalServiceImpl

Generated:

Method Summary

Methods

Modifier and Type	Method and Description
MBBan	addBan(long userId, long banUserId, ServiceContext serviceContext)
MBBan	addMBBan(MBBan mbBan) Adds the message boards ban to the database.
void	checkBan(long groupId, long banUserId)
MBBan	createMBBan(long banId) Creates a new message boards ban with the primary key.
void	deleteBan(long banId)
void	deleteBan(long banUserId, ServiceContext serviceContext)
void	deleteBan(MBBan ban)
void	deleteBansByBanUserId(long banUserId)
void	deleteBansByGroupId(long groupId)
MBBan	deleteMBBan(long banId) Deletes the message boards ban with the primary key from the database.
MBBan	deleteMBBan(MBBan mbBan) Deletes the message boards ban from the database.
DynamicQuery	dynamicQuery()
java.util.List	dynamicQuery(DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.
java.util.List	dynamicQuery(DynamicQuery dynamicQuery, int start, int end) Performs a dynamic query on the database and returns a range of the matching rows.
java.util.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.
long	dynamicQueryCount(DynamicQuery dynamicQuery) Returns the number of rows that match the dynamic query.
long	dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection) Returns the number of rows that match the dynamic query.
void	expireBans()
MBBan	fetchMBBan(long banId)
MBBan	fetchMBBanByUuidAndCompanyId(java.lang.String uuid, long companyId) Returns the message boards ban with the matching UUID and company.
MBBan	fetchMBBanByUuidAndGroupId(java.lang.String uuid, long groupId) Returns the message boards ban matching the UUID and group.
java.util.List<MBBan>	getBans(long groupId, int start, int end)
int	getBansCount(long groupId)
java.lang.String	getBeanIdentifier() Returns the Spring bean ID for this bean.
MBBan	getMBBan(long banId) Returns the message boards ban with the primary key.
MBBan	getMBBanByUuidAndCompanyId(java.lang.String uuid, long companyId) Returns the message boards ban with the matching UUID and company.
MBBan	getMBBanByUuidAndGroupId(java.lang.String uuid, long groupId) Returns the message boards ban matching the UUID and group.
java.util.List<MBBan>	getMBBans(int start, int end) Returns a range of all the message boards bans.
int	getMBBansCount() Returns the number of message boards bans.
PersistedModel	getPersistedModel(java.io.Serializable primaryKeyObj)
boolean	hasBan(long groupId, long banUserId)
void	setBeanIdentifier(java.lang.String beanIdentifier) Sets the Spring bean ID for this bean.
MBBan	updateMBBan(MBBan mbBan) Updates the message boards ban in the database or adds it if it does not yet exist.

Method Detail

addMBBan

@Indexable(type=REINDEX)
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

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

@Indexable(type=DELETE)
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

@Indexable(type=DELETE)
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

DynamicQuery dynamicQuery()

dynamicQuery

java.util.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

java.util.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

java.util.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

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

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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
MBBan fetchMBBan(long banId)
                 throws SystemException

Throws:

SystemException

fetchMBBanByUuidAndCompanyId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
MBBan fetchMBBanByUuidAndCompanyId(java.lang.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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
MBBan fetchMBBanByUuidAndGroupId(java.lang.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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
PersistedModel getPersistedModel(java.io.Serializable primaryKeyObj)
                                 throws PortalException,
                                        SystemException

Specified by:

getPersistedModel in interface PersistedModelLocalService

Throws:

PortalException

SystemException

getMBBanByUuidAndCompanyId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
MBBan getMBBanByUuidAndCompanyId(java.lang.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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
MBBan getMBBanByUuidAndGroupId(java.lang.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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

@Indexable(type=REINDEX)
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

java.lang.String getBeanIdentifier()

Returns the Spring bean ID for this bean.

Returns:

the Spring bean ID for this bean

setBeanIdentifier

void setBeanIdentifier(java.lang.String beanIdentifier)

Sets the Spring bean ID for this bean.

Parameters:

beanIdentifier - the Spring bean ID for this bean

addBan

MBBan addBan(long userId,
           long banUserId,
           ServiceContext serviceContext)
             throws PortalException,
                    SystemException

Throws:

PortalException

SystemException

checkBan

@Transactional(propagation=SUPPORTS,
               readOnly=true)
void checkBan(long groupId,
                                                     long banUserId)
              throws PortalException,
                     SystemException

Throws:

PortalException

SystemException

deleteBan

void deleteBan(long banId)
               throws PortalException,
                      SystemException

Throws:

PortalException

SystemException

deleteBan

void deleteBan(long banUserId,
             ServiceContext serviceContext)
               throws SystemException

Throws:

SystemException

deleteBan

@SystemEvent(type=1)
void deleteBan(MBBan ban)
               throws SystemException

Throws:

SystemException

deleteBansByBanUserId

void deleteBansByBanUserId(long banUserId)
                           throws SystemException

Throws:

SystemException

deleteBansByGroupId

void deleteBansByGroupId(long groupId)
                         throws SystemException

Throws:

SystemException

expireBans

void expireBans()
                throws SystemException

Throws:

SystemException

getBans

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<MBBan> getBans(long groupId,
                                                                     int start,
                                                                     int end)
                              throws SystemException

Throws:

SystemException

getBansCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getBansCount(long groupId)
                 throws SystemException

Throws:

SystemException

hasBan

@Transactional(propagation=SUPPORTS,
               readOnly=true)
boolean hasBan(long groupId,
                                                      long banUserId)
               throws SystemException

Throws:

SystemException