Liferay 6.0.5

com.liferay.portlet.messageboards.service
Interface MBBanLocalService

All Known Implementing Classes:
MBBanLocalServiceBaseImpl, MBBanLocalServiceImpl, MBBanLocalServiceWrapper

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

The interface for the message boards ban local service.

Never modify or reference this interface directly. Always use MBBanLocalServiceUtil to access the message boards ban local service. Add custom service methods to MBBanLocalServiceImpl and rerun ServiceBuilder to automatically copy the method declarations to this interface.

This is a local service. 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:
MBBanLocalServiceUtil, MBBanLocalServiceBaseImpl, MBBanLocalServiceImpl
ServiceBuilder generated this class. Modifications in this class will be overwritten the next time is generated.

Method Summary
 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 banUserId, ServiceContext serviceContext)
           
 void deleteBansByBanUserId(long banUserId)
           
 void deleteBansByGroupId(long groupId)
           
 void deleteMBBan(long banId)
          Deletes the message boards ban with the primary key from the database.
 void deleteMBBan(MBBan mbBan)
          Deletes the message boards ban from the database.
 List dynamicQuery(DynamicQuery dynamicQuery)
          Performs a dynamic query on the database and returns the matching rows.
 List dynamicQuery(DynamicQuery dynamicQuery, int start, int end)
          Performs a dynamic query on the database and returns a range of the matching rows.
 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)
          Counts the number of rows that match the dynamic query.
 void expireBans()
           
 List<MBBan> getBans(long groupId, int start, int end)
           
 int getBansCount(long groupId)
           
 MBBan getMBBan(long banId)
          Gets the message boards ban with the primary key.
 List<MBBan> getMBBans(int start, int end)
          Gets a range of all the message boards bans.
 int getMBBansCount()
          Gets the number of message boards bans.
 boolean hasBan(long groupId, long banUserId)
           
 MBBan updateMBBan(MBBan mbBan)
          Updates the message boards ban in the database.
 MBBan updateMBBan(MBBan mbBan, boolean merge)
          Updates the message boards ban in the database.
 

Method Detail

addMBBan

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 to add
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

void 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 to delete
Throws:
PortalException - if a message boards ban with the primary key could not be found
SystemException - if a system exception occurred

deleteMBBan

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

dynamicQuery

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

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

dynamicQuery

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.

Parameters:
dynamicQuery - the dynamic query to search with
start - the lower bound of the range of model instances to return
end - the upper bound of the range of model instances to return (not inclusive)
Returns:
the range of matching rows
Throws:
SystemException - if a system exception occurred

dynamicQuery

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.

Parameters:
dynamicQuery - the dynamic query to search with
start - the lower bound of the range of model instances to return
end - the upper bound of the range of model instances to return (not inclusive)
orderByComparator - the comparator to order the results by
Returns:
the ordered range of matching rows
Throws:
SystemException - if a system exception occurred

dynamicQueryCount

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

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

getMBBan

@Transactional(propagation=SUPPORTS,
               readOnly=true)
MBBan getMBBan(long banId)
               throws PortalException,
                      SystemException
Gets the message boards ban with the primary key.

Parameters:
banId - the primary key of the message boards ban to get
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

getMBBans

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<MBBan> getMBBans(int start,
                                                               int end)
                      throws SystemException
Gets 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.

Parameters:
start - the lower bound of the range of message boards bans to return
end - the upper bound of the range of message boards bans to return (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
Gets the number of message boards bans.

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

updateMBBan

MBBan updateMBBan(MBBan mbBan)
                  throws SystemException
Updates the message boards ban in the database. Also notifies the appropriate model listeners.

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

updateMBBan

MBBan updateMBBan(MBBan mbBan,
                  boolean merge)
                  throws SystemException
Updates the message boards ban in the database. Also notifies the appropriate model listeners.

Parameters:
mbBan - the message boards ban to update
merge - whether to merge the message boards ban with the current session. See BatchSession.update(com.liferay.portal.kernel.dao.orm.Session, com.liferay.portal.model.BaseModel, boolean) for an explanation.
Returns:
the message boards ban that was updated
Throws:
SystemException - if a system exception occurred

addBan

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

checkBan

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

deleteBan

void deleteBan(long banUserId,
               ServiceContext serviceContext)
               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)
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

Liferay 6.0.5