Liferay 6.0.5

com.liferay.portlet.messageboards.service
Interface MBMailingListLocalService

All Known Implementing Classes:
MBMailingListLocalServiceBaseImpl, MBMailingListLocalServiceImpl, MBMailingListLocalServiceWrapper

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

The interface for the message boards mailing list local service.

Never modify or reference this interface directly. Always use MBMailingListLocalServiceUtil to access the message boards mailing list local service. Add custom service methods to MBMailingListLocalServiceImpl 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:
MBMailingListLocalServiceUtil, MBMailingListLocalServiceBaseImpl, MBMailingListLocalServiceImpl
ServiceBuilder generated this class. Modifications in this class will be overwritten the next time is generated.

Method Summary
 MBMailingList addMailingList(long userId, long groupId, long categoryId, String emailAddress, String inProtocol, String inServerName, int inServerPort, boolean inUseSSL, String inUserName, String inPassword, int inReadInterval, String outEmailAddress, boolean outCustom, String outServerName, int outServerPort, boolean outUseSSL, String outUserName, String outPassword, boolean active, ServiceContext serviceContext)
           
 MBMailingList addMBMailingList(MBMailingList mbMailingList)
          Adds the message boards mailing list to the database.
 MBMailingList createMBMailingList(long mailingListId)
          Creates a new message boards mailing list with the primary key.
 void deleteCategoryMailingList(long groupId, long categoryId)
           
 void deleteMailingList(long mailingListId)
           
 void deleteMailingList(MBMailingList mailingList)
           
 void deleteMBMailingList(long mailingListId)
          Deletes the message boards mailing list with the primary key from the database.
 void deleteMBMailingList(MBMailingList mbMailingList)
          Deletes the message boards mailing list 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.
 MBMailingList getCategoryMailingList(long groupId, long categoryId)
           
 MBMailingList getMBMailingList(long mailingListId)
          Gets the message boards mailing list with the primary key.
 MBMailingList getMBMailingListByUuidAndGroupId(String uuid, long groupId)
          Gets the message boards mailing list with the UUID and group id.
 List<MBMailingList> getMBMailingLists(int start, int end)
          Gets a range of all the message boards mailing lists.
 int getMBMailingListsCount()
          Gets the number of message boards mailing lists.
 MBMailingList updateMailingList(long mailingListId, String emailAddress, String inProtocol, String inServerName, int inServerPort, boolean inUseSSL, String inUserName, String inPassword, int inReadInterval, String outEmailAddress, boolean outCustom, String outServerName, int outServerPort, boolean outUseSSL, String outUserName, String outPassword, boolean active, ServiceContext serviceContext)
           
 MBMailingList updateMBMailingList(MBMailingList mbMailingList)
          Updates the message boards mailing list in the database.
 MBMailingList updateMBMailingList(MBMailingList mbMailingList, boolean merge)
          Updates the message boards mailing list in the database.
 

Method Detail

addMBMailingList

MBMailingList addMBMailingList(MBMailingList mbMailingList)
                               throws SystemException
Adds the message boards mailing list to the database. Also notifies the appropriate model listeners.

Parameters:
mbMailingList - the message boards mailing list to add
Returns:
the message boards mailing list that was added
Throws:
SystemException - if a system exception occurred

createMBMailingList

MBMailingList createMBMailingList(long mailingListId)
Creates a new message boards mailing list with the primary key. Does not add the message boards mailing list to the database.

Parameters:
mailingListId - the primary key for the new message boards mailing list
Returns:
the new message boards mailing list

deleteMBMailingList

void deleteMBMailingList(long mailingListId)
                         throws PortalException,
                                SystemException
Deletes the message boards mailing list with the primary key from the database. Also notifies the appropriate model listeners.

Parameters:
mailingListId - the primary key of the message boards mailing list to delete
Throws:
PortalException - if a message boards mailing list with the primary key could not be found
SystemException - if a system exception occurred

deleteMBMailingList

void deleteMBMailingList(MBMailingList mbMailingList)
                         throws SystemException
Deletes the message boards mailing list from the database. Also notifies the appropriate model listeners.

Parameters:
mbMailingList - the message boards mailing list 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

getMBMailingList

@Transactional(propagation=SUPPORTS,
               readOnly=true)
MBMailingList getMBMailingList(long mailingListId)
                               throws PortalException,
                                      SystemException
Gets the message boards mailing list with the primary key.

Parameters:
mailingListId - the primary key of the message boards mailing list to get
Returns:
the message boards mailing list
Throws:
PortalException - if a message boards mailing list with the primary key could not be found
SystemException - if a system exception occurred

getMBMailingListByUuidAndGroupId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
MBMailingList getMBMailingListByUuidAndGroupId(String uuid,
                                                                                        long groupId)
                                               throws PortalException,
                                                      SystemException
Gets the message boards mailing list with the UUID and group id.

Parameters:
uuid - the UUID of message boards mailing list to get
groupId - the group id of the message boards mailing list to get
Returns:
the message boards mailing list
Throws:
PortalException - if a message boards mailing list with the UUID and group id could not be found
SystemException - if a system exception occurred

getMBMailingLists

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<MBMailingList> getMBMailingLists(int start,
                                                                               int end)
                                      throws SystemException
Gets a range of all the message boards mailing lists.

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 mailing lists to return
end - the upper bound of the range of message boards mailing lists to return (not inclusive)
Returns:
the range of message boards mailing lists
Throws:
SystemException - if a system exception occurred

getMBMailingListsCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getMBMailingListsCount()
                           throws SystemException
Gets the number of message boards mailing lists.

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

updateMBMailingList

MBMailingList updateMBMailingList(MBMailingList mbMailingList)
                                  throws SystemException
Updates the message boards mailing list in the database. Also notifies the appropriate model listeners.

Parameters:
mbMailingList - the message boards mailing list to update
Returns:
the message boards mailing list that was updated
Throws:
SystemException - if a system exception occurred

updateMBMailingList

MBMailingList updateMBMailingList(MBMailingList mbMailingList,
                                  boolean merge)
                                  throws SystemException
Updates the message boards mailing list in the database. Also notifies the appropriate model listeners.

Parameters:
mbMailingList - the message boards mailing list to update
merge - whether to merge the message boards mailing list 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 mailing list that was updated
Throws:
SystemException - if a system exception occurred

addMailingList

MBMailingList addMailingList(long userId,
                             long groupId,
                             long categoryId,
                             String emailAddress,
                             String inProtocol,
                             String inServerName,
                             int inServerPort,
                             boolean inUseSSL,
                             String inUserName,
                             String inPassword,
                             int inReadInterval,
                             String outEmailAddress,
                             boolean outCustom,
                             String outServerName,
                             int outServerPort,
                             boolean outUseSSL,
                             String outUserName,
                             String outPassword,
                             boolean active,
                             ServiceContext serviceContext)
                             throws PortalException,
                                    SystemException
Throws:
PortalException
SystemException

deleteCategoryMailingList

void deleteCategoryMailingList(long groupId,
                               long categoryId)
                               throws PortalException,
                                      SystemException
Throws:
PortalException
SystemException

deleteMailingList

void deleteMailingList(long mailingListId)
                       throws PortalException,
                              SystemException
Throws:
PortalException
SystemException

deleteMailingList

void deleteMailingList(MBMailingList mailingList)
                       throws PortalException,
                              SystemException
Throws:
PortalException
SystemException

getCategoryMailingList

@Transactional(propagation=SUPPORTS,
               readOnly=true)
MBMailingList getCategoryMailingList(long groupId,
                                                                              long categoryId)
                                     throws PortalException,
                                            SystemException
Throws:
PortalException
SystemException

updateMailingList

MBMailingList updateMailingList(long mailingListId,
                                String emailAddress,
                                String inProtocol,
                                String inServerName,
                                int inServerPort,
                                boolean inUseSSL,
                                String inUserName,
                                String inPassword,
                                int inReadInterval,
                                String outEmailAddress,
                                boolean outCustom,
                                String outServerName,
                                int outServerPort,
                                boolean outUseSSL,
                                String outUserName,
                                String outPassword,
                                boolean active,
                                ServiceContext serviceContext)
                                throws PortalException,
                                       SystemException
Throws:
PortalException
SystemException

Liferay 6.0.5