com.liferay.message.boards.kernel.service

Interface MBMailingListLocalService

All Superinterfaces:

BaseLocalService, PersistedModelLocalService

All Known Implementing Classes:

MBMailingListLocalServiceWrapper

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

Provides the local service interface for MBMailingList. 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:

MBMailingListLocalServiceUtil, MBMailingListLocalServiceBaseImpl, MBMailingListLocalServiceImpl

{$generated.description}

Method Summary

Modifier and Type	Method and Description
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.
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.
MBMailingList	fetchCategoryMailingList(long groupId, long categoryId)
MBMailingList	fetchMBMailingList(long mailingListId)
MBMailingList	fetchMBMailingListByUuidAndGroupId(String uuid, long groupId) Returns the message boards mailing list matching the UUID and group.
ActionableDynamicQuery	getActionableDynamicQuery()
MBMailingList	getCategoryMailingList(long groupId, long categoryId)
ExportActionableDynamicQuery	getExportActionableDynamicQuery(PortletDataContext portletDataContext)
IndexableActionableDynamicQuery	getIndexableActionableDynamicQuery()
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 matching the UUID and group.
List<MBMailingList>	getMBMailingLists(int start, int end) Returns a range of all the message boards mailing lists.
List<MBMailingList>	getMBMailingListsByUuidAndCompanyId(String uuid, long companyId) Returns all the message boards mailing lists matching the UUID and company.
List<MBMailingList>	getMBMailingListsByUuidAndCompanyId(String uuid, long companyId, int start, int end, OrderByComparator<MBMailingList> orderByComparator) Returns a range of message boards mailing lists matching the UUID and company.
int	getMBMailingListsCount() Returns the number of message boards mailing lists.
String	getOSGiServiceIdentifier() Returns the OSGi service identifier.
PersistedModel	getPersistedModel(Serializable primaryKeyObj)
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.

Method Detail

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

Throws:

PortalException

addMBMailingList

@Indexable(type=REINDEX)
MBMailingList addMBMailingList(MBMailingList mbMailingList)

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

createMBMailingList

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

deleteCategoryMailingList

void deleteCategoryMailingList(long groupId,
                               long categoryId)
                        throws PortalException

Throws:

PortalException

deleteMailingList

void deleteMailingList(long mailingListId)
                throws PortalException

Throws:

PortalException

deleteMailingList

void deleteMailingList(MBMailingList mailingList)
                throws PortalException

Throws:

PortalException

deleteMBMailingList

@Indexable(type=DELETE)
MBMailingList deleteMBMailingList(long mailingListId)
                                                   throws PortalException

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

deleteMBMailingList

@Indexable(type=DELETE)
MBMailingList deleteMBMailingList(MBMailingList mbMailingList)

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

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

fetchCategoryMailingList

@Transactional(propagation=SUPPORTS,
               readOnly=true)
MBMailingList fetchCategoryMailingList(long groupId,
                                                                                                          long categoryId)

fetchMBMailingList

@Transactional(propagation=SUPPORTS,
               readOnly=true)
MBMailingList fetchMBMailingList(long mailingListId)

fetchMBMailingListByUuidAndGroupId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
MBMailingList fetchMBMailingListByUuidAndGroupId(String uuid,
                                                                                                                    long groupId)

Returns the message boards mailing list matching the UUID and group.

Parameters:

uuid - the message boards mailing list's UUID

groupId - the primary key of the group

Returns:

the matching message boards mailing list, or null if a matching message boards mailing list could not be found

getActionableDynamicQuery

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

getCategoryMailingList

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

Throws:

PortalException

getExportActionableDynamicQuery

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

getIndexableActionableDynamicQuery

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

getMBMailingList

@Transactional(propagation=SUPPORTS,
               readOnly=true)
MBMailingList getMBMailingList(long mailingListId)
                                                                                           throws PortalException

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

getMBMailingListByUuidAndGroupId

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

Returns the message boards mailing list matching the UUID and group.

Parameters:

uuid - the message boards mailing list's UUID

groupId - the primary key of the group

Returns:

the matching message boards mailing list

Throws:

PortalException - if a matching message boards mailing list could not be found

getMBMailingLists

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

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. 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 MBMailingListModelImpl. 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 mailing lists

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

Returns:

the range of message boards mailing lists

getMBMailingListsByUuidAndCompanyId

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

Returns all the message boards mailing lists matching the UUID and company.

Parameters:

uuid - the UUID of the message boards mailing lists

companyId - the primary key of the company

Returns:

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

getMBMailingListsByUuidAndCompanyId

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

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

Parameters:

uuid - the UUID of the message boards mailing lists

companyId - the primary key of the company

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)

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

Returns:

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

getMBMailingListsCount

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

Returns the number of message boards mailing lists.

Returns:

the number of message boards mailing lists

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

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

Throws:

PortalException

updateMBMailingList

@Indexable(type=REINDEX)
MBMailingList updateMBMailingList(MBMailingList mbMailingList)

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