Liferay 7.0-ce-b4

com.liferay.portlet.messageboards.service
Class MBMailingListLocalServiceUtil

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

@ProviderType
public class MBMailingListLocalServiceUtil
extends Object

Provides the local service utility for MBMailingList. 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. 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 PersistedModel deletePersistedModel(PersistedModel persistedModel)
           
static DynamicQuery dynamicQuery()
           
static
<T> List<T>
dynamicQuery(DynamicQuery dynamicQuery)
          Performs a dynamic query on the database and returns the matching rows.
static
<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.
static
<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.
static long dynamicQueryCount(DynamicQuery dynamicQuery)
          Returns the number of rows matching the dynamic query.
static long dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection)
          Returns the number of rows matching the dynamic query.
static MBMailingList fetchCategoryMailingList(long groupId, long categoryId)
           
static MBMailingList fetchMBMailingList(long mailingListId)
           
static MBMailingList fetchMBMailingListByUuidAndGroupId(String uuid, long groupId)
          Returns the message boards mailing list matching the UUID and group.
static ActionableDynamicQuery getActionableDynamicQuery()
           
static MBMailingList getCategoryMailingList(long groupId, long categoryId)
           
static ExportActionableDynamicQuery getExportActionableDynamicQuery(PortletDataContext portletDataContext)
           
static IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()
           
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 matching the UUID and group.
static List<MBMailingList> getMBMailingLists(int start, int end)
          Returns a range of all the message boards mailing lists.
static List<MBMailingList> getMBMailingListsByUuidAndCompanyId(String uuid, long companyId)
          Returns all the message boards mailing lists matching the UUID and company.
static 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.
static int getMBMailingListsCount()
          Returns the number of message boards mailing lists.
static String getOSGiServiceIdentifier()
          Returns the OSGi service identifier.
static PersistedModel getPersistedModel(Serializable primaryKeyObj)
           
static MBMailingListLocalService getService()
           
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.
 
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)
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

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
Throws:
PortalException

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

deleteCategoryMailingList

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

deleteMBMailingList

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

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

deleteMailingList

public static void deleteMailingList(MBMailingList mailingList)
                              throws PortalException
Throws:
PortalException

deleteMailingList

public static void deleteMailingList(long mailingListId)
                              throws PortalException
Throws:
PortalException

deletePersistedModel

public static PersistedModel deletePersistedModel(PersistedModel persistedModel)
                                           throws PortalException
Throws:
PortalException

dynamicQuery

public static DynamicQuery dynamicQuery()

dynamicQuery

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

public static <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 com.liferay.portlet.messageboards.model.impl.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

public static <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 com.liferay.portlet.messageboards.model.impl.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

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

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

public static MBMailingList fetchCategoryMailingList(long groupId,
                                                     long categoryId)

fetchMBMailingList

public static MBMailingList fetchMBMailingList(long mailingListId)

fetchMBMailingListByUuidAndGroupId

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

public static ActionableDynamicQuery getActionableDynamicQuery()

getCategoryMailingList

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

getExportActionableDynamicQuery

public static ExportActionableDynamicQuery getExportActionableDynamicQuery(PortletDataContext portletDataContext)

getIndexableActionableDynamicQuery

public static IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()

getMBMailingList

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

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

public static 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 com.liferay.portlet.messageboards.model.impl.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

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

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

public static int getMBMailingListsCount()
Returns the number of message boards mailing lists.

Returns:
the number of message boards mailing lists

getOSGiServiceIdentifier

public static String getOSGiServiceIdentifier()
Returns the OSGi service identifier.

Returns:
the OSGi service identifier

getPersistedModel

public static PersistedModel getPersistedModel(Serializable primaryKeyObj)
                                        throws PortalException
Throws:
PortalException

updateMBMailingList

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

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
Throws:
PortalException

getService

public static MBMailingListLocalService getService()

Liferay 7.0-ce-b4