com.liferay.message.boards.kernel.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, MBBanLocalServiceBaseImpl, MBBanLocalServiceImpl

{$generated.description}

Method Summary

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.
PersistedModel	deletePersistedModel(PersistedModel persistedModel)
DynamicQuery	dynamicQuery()
<T> List<T>	dynamicQuery(DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.
<T> List<T>	dynamicQuery(DynamicQuery dynamicQuery, int start, int end) Performs a dynamic query on the database and returns a range of the matching rows.
<T> List<T>	dynamicQuery(DynamicQuery dynamicQuery, int start, int end, OrderByComparator<T> 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 matching the dynamic query.
long	dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection) Returns the number of rows matching the dynamic query.
void	expireBans()
MBBan	fetchMBBan(long banId)
MBBan	fetchMBBanByUuidAndGroupId(String uuid, long groupId) Returns the message boards ban matching the UUID and group.
ActionableDynamicQuery	getActionableDynamicQuery()
List<MBBan>	getBans(long groupId, int start, int end)
int	getBansCount(long groupId)
ExportActionableDynamicQuery	getExportActionableDynamicQuery(PortletDataContext portletDataContext)
IndexableActionableDynamicQuery	getIndexableActionableDynamicQuery()
MBBan	getMBBan(long banId) Returns the message boards ban with the primary key.
MBBan	getMBBanByUuidAndGroupId(String uuid, long groupId) Returns the message boards ban matching the UUID and group.
List<MBBan>	getMBBans(int start, int end) Returns a range of all the message boards bans.
List<MBBan>	getMBBansByUuidAndCompanyId(String uuid, long companyId) Returns all the message boards bans matching the UUID and company.
List<MBBan>	getMBBansByUuidAndCompanyId(String uuid, long companyId, int start, int end, OrderByComparator<MBBan> orderByComparator) Returns a range of message boards bans matching the UUID and company.
int	getMBBansCount() Returns the number of message boards bans.
String	getOSGiServiceIdentifier() Returns the OSGi service identifier.
PersistedModel	getPersistedModel(Serializable primaryKeyObj)
boolean	hasBan(long groupId, long banUserId)
MBBan	updateMBBan(MBBan mbBan) Updates the message boards ban in the database or adds it if it does not yet exist.

Method Detail

addBan

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

Throws:

PortalException

addMBBan

@Indexable(type=REINDEX)
MBBan addMBBan(MBBan mbBan)

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

checkBan

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

Throws:

PortalException

createMBBan

@Transactional(enabled=false)
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

deleteBan

void deleteBan(long banId)
        throws PortalException

Throws:

PortalException

deleteBan

void deleteBan(long banUserId,
               ServiceContext serviceContext)

deleteBan

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

deleteBansByBanUserId

void deleteBansByBanUserId(long banUserId)

deleteBansByGroupId

void deleteBansByGroupId(long groupId)

deleteMBBan

@Indexable(type=DELETE)
MBBan deleteMBBan(long banId)
                                   throws PortalException

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

deleteMBBan

@Indexable(type=DELETE)
MBBan deleteMBBan(MBBan mbBan)

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

deletePersistedModel

PersistedModel deletePersistedModel(PersistedModel persistedModel)
                             throws PortalException

Specified by:

deletePersistedModel in interface PersistedModelLocalService

Throws:

PortalException

dynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
DynamicQuery dynamicQuery()

dynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
<T> List<T> dynamicQuery(DynamicQuery dynamicQuery)

Performs a dynamic query on the database and returns the matching rows.

Parameters:

dynamicQuery - the dynamic query

Returns:

the matching rows

dynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
<T> List<T> dynamicQuery(DynamicQuery dynamicQuery,
                                                                                            int start,
                                                                                            int end)

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

dynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
<T> List<T> dynamicQuery(DynamicQuery dynamicQuery,
                                                                                            int start,
                                                                                            int end,
                                                                                            OrderByComparator<T> orderByComparator)

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

dynamicQueryCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
long dynamicQueryCount(DynamicQuery dynamicQuery)

Returns the number of rows matching the dynamic query.

Parameters:

dynamicQuery - the dynamic query

Returns:

the number of rows matching the dynamic query

dynamicQueryCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
long dynamicQueryCount(DynamicQuery dynamicQuery,
                                                                                          Projection projection)

Returns the number of rows matching the dynamic query.

Parameters:

dynamicQuery - the dynamic query

projection - the projection to apply to the query

Returns:

the number of rows matching the dynamic query

expireBans

void expireBans()

fetchMBBan

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

fetchMBBanByUuidAndGroupId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
MBBan fetchMBBanByUuidAndGroupId(String uuid,
                                                                                                    long groupId)

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

getActionableDynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
ActionableDynamicQuery getActionableDynamicQuery()

getBans

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

getBansCount

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

getExportActionableDynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
ExportActionableDynamicQuery getExportActionableDynamicQuery(PortletDataContext portletDataContext)

getIndexableActionableDynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()

getMBBan

@Transactional(propagation=SUPPORTS,
               readOnly=true)
MBBan getMBBan(long banId)
                                                                           throws PortalException

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

getMBBanByUuidAndGroupId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
MBBan getMBBanByUuidAndGroupId(String uuid,
                                                                                                  long groupId)
                                                                                           throws PortalException

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

getMBBans

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<MBBan> getMBBans(int start,
                                                                                         int end)

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

getMBBansByUuidAndCompanyId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<MBBan> getMBBansByUuidAndCompanyId(String uuid,
                                                                                                           long companyId)

Returns all the message boards bans matching the UUID and company.

Parameters:

uuid - the UUID of the message boards bans

companyId - the primary key of the company

Returns:

the matching message boards bans, or an empty list if no matches were found

getMBBansByUuidAndCompanyId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<MBBan> getMBBansByUuidAndCompanyId(String uuid,
                                                                                                           long companyId,
                                                                                                           int start,
                                                                                                           int end,
                                                                                                           OrderByComparator<MBBan> orderByComparator)

Returns a range of message boards bans matching the UUID and company.

Parameters:

uuid - the UUID of the message boards bans

companyId - the primary key of the company

start - the lower bound of the range of message boards bans

end - the upper bound of the range of message boards bans (not inclusive)

orderByComparator - the comparator to order the results by (optionally null)

Returns:

the range of matching message boards bans, or an empty list if no matches were found

getMBBansCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getMBBansCount()

Returns the number of message boards bans.

Returns:

the number of message boards bans

getOSGiServiceIdentifier

String getOSGiServiceIdentifier()

Returns the OSGi service identifier.

Returns:

the OSGi service identifier

getPersistedModel

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

Specified by:

getPersistedModel in interface PersistedModelLocalService

Throws:

PortalException

hasBan

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

updateMBBan

@Indexable(type=REINDEX)
MBBan updateMBBan(MBBan mbBan)

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