Liferay 6.1.2-ce-ga3

com.liferay.portlet.messageboards.service
Interface MBMailingListLocalService

All Superinterfaces:
BaseLocalService, PersistedModelLocalService
All Known Implementing Classes:
MBMailingListLocalServiceWrapper

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

The interface for the message boards mailing list local service.

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, com.liferay.portlet.messageboards.service.base.MBMailingListLocalServiceBaseImpl, com.liferay.portlet.messageboards.service.impl.MBMailingListLocalServiceImpl

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 allowAnonymous, 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)
           
 MBMailingList deleteMBMailingList(long mailingListId)
          Deletes the message boards mailing list with the primary key from the database.
 MBMailingList deleteMBMailingList(MBMailingList mbMailingList)
          Deletes the message boards mailing list from the database.
 DynamicQuery dynamicQuery()
           
 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)
          Returns the number of rows that match the dynamic query.
 MBMailingList fetchMBMailingList(long mailingListId)
           
 String getBeanIdentifier()
          Returns the Spring bean ID for this bean.
 MBMailingList getCategoryMailingList(long groupId, long categoryId)
           
 MBMailingList getMBMailingList(long mailingListId)
          Returns the message boards mailing list with the primary key.
 MBMailingList getMBMailingListByUuidAndGroupId(String uuid, long groupId)
          Returns the message boards mailing list with the UUID in the group.
 List<MBMailingList> getMBMailingLists(int start, int end)
          Returns a range of all the message boards mailing lists.
 int getMBMailingListsCount()
          Returns the number of message boards mailing lists.
 PersistedModel getPersistedModel(Serializable primaryKeyObj)
           
 void setBeanIdentifier(String beanIdentifier)
          Sets the Spring bean ID for this bean.
 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 allowAnonymous, boolean active, ServiceContext serviceContext)
           
 MBMailingList updateMBMailingList(MBMailingList mbMailingList)
          Updates the message boards mailing list in the database or adds it if it does not yet exist.
 MBMailingList updateMBMailingList(MBMailingList mbMailingList, boolean merge)
          Updates the message boards mailing list in the database or adds it if it does not yet exist.
 

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

MBMailingList 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
Returns:
the message boards mailing list that was removed
Throws:
PortalException - if a message boards mailing list with the primary key could not be found
SystemException - if a system exception occurred

deleteMBMailingList

MBMailingList 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
Returns:
the message boards mailing list that was removed
Throws:
SystemException - if a system exception occurred

dynamicQuery

DynamicQuery dynamicQuery()

dynamicQuery

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

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

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

fetchMBMailingList

@Transactional(propagation=SUPPORTS,
               readOnly=true)
MBMailingList fetchMBMailingList(long mailingListId)
                                 throws SystemException
Throws:
SystemException

getMBMailingList

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

Parameters:
mailingListId - the primary key of the message boards mailing list
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

getPersistedModel

@Transactional(propagation=SUPPORTS,
               readOnly=true)
PersistedModel getPersistedModel(Serializable primaryKeyObj)
                                 throws PortalException,
                                        SystemException
Specified by:
getPersistedModel in interface PersistedModelLocalService
Throws:
PortalException
SystemException

getMBMailingListByUuidAndGroupId

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

Parameters:
uuid - the UUID of message boards mailing list
groupId - the group id of the message boards mailing list
Returns:
the message boards mailing list
Throws:
PortalException - if a message boards mailing list with the UUID in the group 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
Returns 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
end - the upper bound of the range of message boards mailing lists (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
Returns 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 or adds it if it does not yet exist. Also notifies the appropriate model listeners.

Parameters:
mbMailingList - the message boards mailing list
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 or adds it if it does not yet exist. Also notifies the appropriate model listeners.

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

getBeanIdentifier

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

Returns:
the Spring bean ID for this bean

setBeanIdentifier

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

Parameters:
beanIdentifier - the Spring bean ID for this bean

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 allowAnonymous,
                             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 allowAnonymous,
                                boolean active,
                                ServiceContext serviceContext)
                                throws PortalException,
                                       SystemException
Throws:
PortalException
SystemException

Liferay 6.1.2-ce-ga3