com.liferay.portlet.messageboards.service
Class MBMailingListLocalServiceUtil

java.lang.Object
  com.liferay.portlet.messageboards.service.MBMailingListLocalServiceUtil

public class MBMailingListLocalServiceUtil
extends Object

The utility for the message boards mailing list local service. This utility wraps com.liferay.portlet.messageboards.service.impl.MBMailingListLocalServiceImpl and is the primary access point for service operations in application layer code running on the local server.

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:

MBMailingListLocalService, com.liferay.portlet.messageboards.service.base.MBMailingListLocalServiceBaseImpl, com.liferay.portlet.messageboards.service.impl.MBMailingListLocalServiceImpl

Constructor Summary

MBMailingListLocalServiceUtil()

Method Summary

static 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)
static MBMailingList	addMBMailingList(MBMailingList mbMailingList) Adds the message boards mailing list to the database.
static MBMailingList	createMBMailingList(long mailingListId) Creates a new message boards mailing list with the primary key.
static void	deleteCategoryMailingList(long groupId, long categoryId)
static void	deleteMailingList(long mailingListId)
static void	deleteMailingList(MBMailingList mailingList)
static MBMailingList	deleteMBMailingList(long mailingListId) Deletes the message boards mailing list with the primary key from the database.
static MBMailingList	deleteMBMailingList(MBMailingList mbMailingList) Deletes the message boards mailing list from the database.
static DynamicQuery	dynamicQuery()
static List	dynamicQuery(DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.
static List	dynamicQuery(DynamicQuery dynamicQuery, int start, int end) Performs a dynamic query on the database and returns a range of the matching rows.
static 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.
static long	dynamicQueryCount(DynamicQuery dynamicQuery) Returns the number of rows that match the dynamic query.
static MBMailingList	fetchMBMailingList(long mailingListId)
static String	getBeanIdentifier() Returns the Spring bean ID for this bean.
static MBMailingList	getCategoryMailingList(long groupId, long categoryId)
static MBMailingList	getMBMailingList(long mailingListId) Returns the message boards mailing list with the primary key.
static MBMailingList	getMBMailingListByUuidAndGroupId(String uuid, long groupId) Returns the message boards mailing list with the UUID in the group.
static List<MBMailingList>	getMBMailingLists(int start, int end) Returns a range of all the message boards mailing lists.
static int	getMBMailingListsCount() Returns the number of message boards mailing lists.
static PersistedModel	getPersistedModel(Serializable primaryKeyObj)
static MBMailingListLocalService	getService()
static void	setBeanIdentifier(String beanIdentifier) Sets the Spring bean ID for this bean.
void	setService(MBMailingListLocalService service) Deprecated.
static 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)
static MBMailingList	updateMBMailingList(MBMailingList mbMailingList) Updates the message boards mailing list in the database or adds it if it does not yet exist.
static MBMailingList	updateMBMailingList(MBMailingList mbMailingList, boolean merge) Updates the message boards mailing list in the database or adds it if it does not yet exist.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MBMailingListLocalServiceUtil

public MBMailingListLocalServiceUtil()

Method Detail

addMBMailingList

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

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

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

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

public static DynamicQuery dynamicQuery()

dynamicQuery

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

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

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

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

public static MBMailingList fetchMBMailingList(long mailingListId)
                                        throws SystemException

Throws:

SystemException

getMBMailingList

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

public static PersistedModel getPersistedModel(Serializable primaryKeyObj)
                                        throws PortalException,
                                               SystemException

Throws:

PortalException

SystemException

getMBMailingListByUuidAndGroupId

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

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

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

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

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

public static String getBeanIdentifier()

Returns the Spring bean ID for this bean.

Returns:

the Spring bean ID for this bean

setBeanIdentifier

public static void setBeanIdentifier(String beanIdentifier)

Sets the Spring bean ID for this bean.

Parameters:

beanIdentifier - the Spring bean ID for this bean

addMailingList

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

public static void deleteCategoryMailingList(long groupId,
                                             long categoryId)
                                      throws PortalException,
                                             SystemException

Throws:

PortalException

SystemException

deleteMailingList

public static void deleteMailingList(long mailingListId)
                              throws PortalException,
                                     SystemException

Throws:

PortalException

SystemException

deleteMailingList

public static void deleteMailingList(MBMailingList mailingList)
                              throws PortalException,
                                     SystemException

Throws:

PortalException

SystemException

getCategoryMailingList

public static MBMailingList getCategoryMailingList(long groupId,
                                                   long categoryId)
                                            throws PortalException,
                                                   SystemException

Throws:

PortalException

SystemException

updateMailingList

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

getService

public static MBMailingListLocalService getService()

setService

public void setService(MBMailingListLocalService service)

Deprecated.