@ProviderType
public class MBMailingListLocalServiceUtil
extends Object
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.MBMailingListLocalService
,
MBMailingListLocalServiceBaseImpl
,
MBMailingListLocalServiceImpl
Constructor and Description |
---|
MBMailingListLocalServiceUtil() |
Modifier and Type | Method and Description |
---|---|
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.
|
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
PortalException
public static MBMailingList addMBMailingList(MBMailingList mbMailingList)
mbMailingList
- the message boards mailing listpublic static MBMailingList createMBMailingList(long mailingListId)
mailingListId
- the primary key for the new message boards mailing listpublic static void deleteCategoryMailingList(long groupId, long categoryId) throws PortalException
PortalException
public static void deleteMailingList(long mailingListId) throws PortalException
PortalException
public static void deleteMailingList(MBMailingList mailingList) throws PortalException
PortalException
public static MBMailingList deleteMBMailingList(long mailingListId) throws PortalException
mailingListId
- the primary key of the message boards mailing listPortalException
- if a message boards mailing list with the primary key could not be foundpublic static MBMailingList deleteMBMailingList(MBMailingList mbMailingList)
mbMailingList
- the message boards mailing listpublic static PersistedModel deletePersistedModel(PersistedModel persistedModel) throws PortalException
PortalException
public static DynamicQuery dynamicQuery()
public static <T> List<T> dynamicQuery(DynamicQuery dynamicQuery)
dynamicQuery
- the dynamic querypublic static <T> List<T> dynamicQuery(DynamicQuery dynamicQuery, int start, int end)
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.
dynamicQuery
- the dynamic querystart
- the lower bound of the range of model instancesend
- the upper bound of the range of model instances (not inclusive)public static <T> List<T> dynamicQuery(DynamicQuery dynamicQuery, int start, int end, OrderByComparator<T> orderByComparator)
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.
dynamicQuery
- the dynamic querystart
- the lower bound of the range of model instancesend
- the upper bound of the range of model instances (not inclusive)orderByComparator
- the comparator to order the results by (optionally null
)public static long dynamicQueryCount(DynamicQuery dynamicQuery)
dynamicQuery
- the dynamic querypublic static long dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection)
dynamicQuery
- the dynamic queryprojection
- the projection to apply to the querypublic static MBMailingList fetchCategoryMailingList(long groupId, long categoryId)
public static MBMailingList fetchMBMailingList(long mailingListId)
public static MBMailingList fetchMBMailingListByUuidAndGroupId(String uuid, long groupId)
uuid
- the message boards mailing list's UUIDgroupId
- the primary key of the groupnull
if a matching message boards mailing list could not be foundpublic static ActionableDynamicQuery getActionableDynamicQuery()
public static MBMailingList getCategoryMailingList(long groupId, long categoryId) throws PortalException
PortalException
public static ExportActionableDynamicQuery getExportActionableDynamicQuery(PortletDataContext portletDataContext)
public static IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()
public static MBMailingList getMBMailingList(long mailingListId) throws PortalException
mailingListId
- the primary key of the message boards mailing listPortalException
- if a message boards mailing list with the primary key could not be foundpublic static MBMailingList getMBMailingListByUuidAndGroupId(String uuid, long groupId) throws PortalException
uuid
- the message boards mailing list's UUIDgroupId
- the primary key of the groupPortalException
- if a matching message boards mailing list could not be foundpublic static List<MBMailingList> getMBMailingLists(int start, int end)
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.
start
- the lower bound of the range of message boards mailing listsend
- the upper bound of the range of message boards mailing lists (not inclusive)public static List<MBMailingList> getMBMailingListsByUuidAndCompanyId(String uuid, long companyId)
uuid
- the UUID of the message boards mailing listscompanyId
- the primary key of the companypublic static List<MBMailingList> getMBMailingListsByUuidAndCompanyId(String uuid, long companyId, int start, int end, OrderByComparator<MBMailingList> orderByComparator)
uuid
- the UUID of the message boards mailing listscompanyId
- the primary key of the companystart
- the lower bound of the range of message boards mailing listsend
- the upper bound of the range of message boards mailing lists (not inclusive)orderByComparator
- the comparator to order the results by (optionally null
)public static int getMBMailingListsCount()
public static String getOSGiServiceIdentifier()
public static PersistedModel getPersistedModel(Serializable primaryKeyObj) throws PortalException
PortalException
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
PortalException
public static MBMailingList updateMBMailingList(MBMailingList mbMailingList)
mbMailingList
- the message boards mailing listpublic static MBMailingListLocalService getService()