@ProviderType
public class MBCategoryLocalServiceUtil
extends Object
MBCategoryLocalServiceImpl
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.MBCategoryLocalService
,
MBCategoryLocalServiceBaseImpl
,
MBCategoryLocalServiceImpl
Constructor and Description |
---|
MBCategoryLocalServiceUtil() |
Modifier and Type | Method and Description |
---|---|
static MBCategory |
addCategory(long userId,
long parentCategoryId,
String name,
String description,
ServiceContext serviceContext) |
static MBCategory |
addCategory(long userId,
long parentCategoryId,
String name,
String description,
String displayStyle,
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 mailingListActive,
ServiceContext serviceContext) |
static void |
addCategoryResources(long categoryId,
boolean addGroupPermissions,
boolean addGuestPermissions) |
static void |
addCategoryResources(long categoryId,
ModelPermissions modelPermissions) |
static void |
addCategoryResources(MBCategory category,
boolean addGroupPermissions,
boolean addGuestPermissions) |
static void |
addCategoryResources(MBCategory category,
ModelPermissions modelPermissions) |
static MBCategory |
addMBCategory(MBCategory mbCategory)
Adds the message boards category to the database.
|
static MBCategory |
createMBCategory(long categoryId)
Creates a new message boards category with the primary key.
|
static void |
deleteCategories(long groupId) |
static void |
deleteCategory(long categoryId) |
static void |
deleteCategory(MBCategory category) |
static void |
deleteCategory(MBCategory category,
boolean includeTrashedEntries) |
static MBCategory |
deleteMBCategory(long categoryId)
Deletes the message boards category with the primary key from the database.
|
static MBCategory |
deleteMBCategory(MBCategory mbCategory)
Deletes the message boards category 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 MBCategory |
fetchMBCategory(long categoryId) |
static MBCategory |
fetchMBCategoryByUuidAndGroupId(String uuid,
long groupId)
Returns the message boards category matching the UUID and group.
|
static ActionableDynamicQuery |
getActionableDynamicQuery() |
static List<MBCategory> |
getCategories(long groupId) |
static List<MBCategory> |
getCategories(long groupId,
int status) |
static List<MBCategory> |
getCategories(long groupId,
long[] parentCategoryIds,
int start,
int end) |
static List<MBCategory> |
getCategories(long groupId,
long[] parentCategoryIds,
int status,
int start,
int end) |
static List<MBCategory> |
getCategories(long groupId,
long[] excludedCategoryIds,
long[] parentCategoryIds,
int status,
int start,
int end) |
static List<MBCategory> |
getCategories(long groupId,
long parentCategoryId,
int start,
int end) |
static List<MBCategory> |
getCategories(long groupId,
long parentCategoryId,
int status,
int start,
int end) |
static List<MBCategory> |
getCategories(long groupId,
long excludedCategoryId,
long parentCategoryId,
int status,
int start,
int end) |
static List<Object> |
getCategoriesAndThreads(long groupId,
long categoryId) |
static List<Object> |
getCategoriesAndThreads(long groupId,
long categoryId,
int status) |
static List<Object> |
getCategoriesAndThreads(long groupId,
long categoryId,
int status,
int start,
int end) |
static int |
getCategoriesAndThreadsCount(long groupId,
long categoryId) |
static int |
getCategoriesAndThreadsCount(long groupId,
long categoryId,
int status) |
static int |
getCategoriesCount(long groupId) |
static int |
getCategoriesCount(long groupId,
int status) |
static int |
getCategoriesCount(long groupId,
long parentCategoryId) |
static int |
getCategoriesCount(long groupId,
long[] parentCategoryIds) |
static int |
getCategoriesCount(long groupId,
long[] parentCategoryIds,
int status) |
static int |
getCategoriesCount(long groupId,
long[] excludedCategoryIds,
long[] parentCategoryIds,
int status) |
static int |
getCategoriesCount(long groupId,
long parentCategoryId,
int status) |
static int |
getCategoriesCount(long groupId,
long excludedCategoryId,
long parentCategoryId,
int status) |
static MBCategory |
getCategory(long categoryId) |
static List<MBCategory> |
getCompanyCategories(long companyId,
int start,
int end) |
static int |
getCompanyCategoriesCount(long companyId) |
static ExportActionableDynamicQuery |
getExportActionableDynamicQuery(PortletDataContext portletDataContext) |
static IndexableActionableDynamicQuery |
getIndexableActionableDynamicQuery() |
static List<MBCategory> |
getMBCategories(int start,
int end)
Returns a range of all the message boards categories.
|
static List<MBCategory> |
getMBCategoriesByUuidAndCompanyId(String uuid,
long companyId)
Returns all the message boards categories matching the UUID and company.
|
static List<MBCategory> |
getMBCategoriesByUuidAndCompanyId(String uuid,
long companyId,
int start,
int end,
OrderByComparator<MBCategory> orderByComparator)
Returns a range of message boards categories matching the UUID and company.
|
static int |
getMBCategoriesCount()
Returns the number of message boards categories.
|
static MBCategory |
getMBCategory(long categoryId)
Returns the message boards category with the primary key.
|
static MBCategory |
getMBCategoryByUuidAndGroupId(String uuid,
long groupId)
Returns the message boards category matching the UUID and group.
|
static String |
getOSGiServiceIdentifier()
Returns the OSGi service identifier.
|
static PersistedModel |
getPersistedModel(Serializable primaryKeyObj) |
static MBCategoryLocalService |
getService() |
static List<Long> |
getSubcategoryIds(List<Long> categoryIds,
long groupId,
long categoryId) |
static List<MBCategory> |
getSubscribedCategories(long groupId,
long userId,
int start,
int end) |
static int |
getSubscribedCategoriesCount(long groupId,
long userId) |
static void |
moveCategoriesToTrash(long groupId,
long userId) |
static MBCategory |
moveCategory(long categoryId,
long parentCategoryId,
boolean mergeWithParentCategory) |
static MBCategory |
moveCategoryFromTrash(long userId,
long categoryId,
long newCategoryId) |
static MBCategory |
moveCategoryToTrash(long userId,
long categoryId) |
static void |
restoreCategoryFromTrash(long userId,
long categoryId) |
static void |
subscribeCategory(long userId,
long groupId,
long categoryId) |
static void |
unsubscribeCategory(long userId,
long groupId,
long categoryId) |
static MBCategory |
updateCategory(long categoryId,
long parentCategoryId,
String name,
String description,
String displayStyle,
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 mailingListActive,
boolean mergeWithParentCategory,
ServiceContext serviceContext) |
static MBCategory |
updateMBCategory(MBCategory mbCategory)
Updates the message boards category in the database or adds it if it does not yet exist.
|
static MBCategory |
updateMessageCount(long categoryId) |
static MBCategory |
updateStatistics(long categoryId) |
static MBCategory |
updateStatus(long userId,
long categoryId,
int status) |
static MBCategory |
updateThreadCount(long categoryId) |
public static MBCategory addCategory(long userId, long parentCategoryId, String name, String description, ServiceContext serviceContext) throws PortalException
PortalException
public static MBCategory addCategory(long userId, long parentCategoryId, String name, String description, String displayStyle, 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 mailingListActive, ServiceContext serviceContext) throws PortalException
PortalException
public static void addCategoryResources(long categoryId, boolean addGroupPermissions, boolean addGuestPermissions) throws PortalException
PortalException
public static void addCategoryResources(long categoryId, ModelPermissions modelPermissions) throws PortalException
PortalException
public static void addCategoryResources(MBCategory category, boolean addGroupPermissions, boolean addGuestPermissions) throws PortalException
PortalException
public static void addCategoryResources(MBCategory category, ModelPermissions modelPermissions) throws PortalException
PortalException
public static MBCategory addMBCategory(MBCategory mbCategory)
mbCategory
- the message boards categorypublic static MBCategory createMBCategory(long categoryId)
categoryId
- the primary key for the new message boards categorypublic static void deleteCategories(long groupId) throws PortalException
PortalException
public static void deleteCategory(long categoryId) throws PortalException
PortalException
public static void deleteCategory(MBCategory category) throws PortalException
PortalException
public static void deleteCategory(MBCategory category, boolean includeTrashedEntries) throws PortalException
PortalException
public static MBCategory deleteMBCategory(long categoryId) throws PortalException
categoryId
- the primary key of the message boards categoryPortalException
- if a message boards category with the primary key could not be foundpublic static MBCategory deleteMBCategory(MBCategory mbCategory)
mbCategory
- the message boards categorypublic 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 MBCategoryModelImpl
. 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 MBCategoryModelImpl
. 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 MBCategory fetchMBCategory(long categoryId)
public static MBCategory fetchMBCategoryByUuidAndGroupId(String uuid, long groupId)
uuid
- the message boards category's UUIDgroupId
- the primary key of the groupnull
if a matching message boards category could not be foundpublic static ActionableDynamicQuery getActionableDynamicQuery()
public static List<MBCategory> getCategories(long groupId)
public static List<MBCategory> getCategories(long groupId, int status)
public static List<MBCategory> getCategories(long groupId, long parentCategoryId, int start, int end)
public static List<MBCategory> getCategories(long groupId, long parentCategoryId, int status, int start, int end)
public static List<MBCategory> getCategories(long groupId, long excludedCategoryId, long parentCategoryId, int status, int start, int end)
public static List<MBCategory> getCategories(long groupId, long[] parentCategoryIds, int start, int end)
public static List<MBCategory> getCategories(long groupId, long[] parentCategoryIds, int status, int start, int end)
public static List<MBCategory> getCategories(long groupId, long[] excludedCategoryIds, long[] parentCategoryIds, int status, int start, int end)
public static List<Object> getCategoriesAndThreads(long groupId, long categoryId)
public static List<Object> getCategoriesAndThreads(long groupId, long categoryId, int status)
public static List<Object> getCategoriesAndThreads(long groupId, long categoryId, int status, int start, int end)
public static int getCategoriesAndThreadsCount(long groupId, long categoryId)
public static int getCategoriesAndThreadsCount(long groupId, long categoryId, int status)
public static int getCategoriesCount(long groupId)
public static int getCategoriesCount(long groupId, int status)
public static int getCategoriesCount(long groupId, long parentCategoryId)
public static int getCategoriesCount(long groupId, long parentCategoryId, int status)
public static int getCategoriesCount(long groupId, long excludedCategoryId, long parentCategoryId, int status)
public static int getCategoriesCount(long groupId, long[] parentCategoryIds)
public static int getCategoriesCount(long groupId, long[] parentCategoryIds, int status)
public static int getCategoriesCount(long groupId, long[] excludedCategoryIds, long[] parentCategoryIds, int status)
public static MBCategory getCategory(long categoryId) throws PortalException
PortalException
public static List<MBCategory> getCompanyCategories(long companyId, int start, int end)
public static int getCompanyCategoriesCount(long companyId)
public static ExportActionableDynamicQuery getExportActionableDynamicQuery(PortletDataContext portletDataContext)
public static IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()
public static List<MBCategory> getMBCategories(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 MBCategoryModelImpl
. 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 categoriesend
- the upper bound of the range of message boards categories (not inclusive)public static List<MBCategory> getMBCategoriesByUuidAndCompanyId(String uuid, long companyId)
uuid
- the UUID of the message boards categoriescompanyId
- the primary key of the companypublic static List<MBCategory> getMBCategoriesByUuidAndCompanyId(String uuid, long companyId, int start, int end, OrderByComparator<MBCategory> orderByComparator)
uuid
- the UUID of the message boards categoriescompanyId
- the primary key of the companystart
- the lower bound of the range of message boards categoriesend
- the upper bound of the range of message boards categories (not inclusive)orderByComparator
- the comparator to order the results by (optionally null
)public static int getMBCategoriesCount()
public static MBCategory getMBCategory(long categoryId) throws PortalException
categoryId
- the primary key of the message boards categoryPortalException
- if a message boards category with the primary key could not be foundpublic static MBCategory getMBCategoryByUuidAndGroupId(String uuid, long groupId) throws PortalException
uuid
- the message boards category's UUIDgroupId
- the primary key of the groupPortalException
- if a matching message boards category could not be foundpublic static String getOSGiServiceIdentifier()
public static PersistedModel getPersistedModel(Serializable primaryKeyObj) throws PortalException
PortalException
public static List<Long> getSubcategoryIds(List<Long> categoryIds, long groupId, long categoryId)
public static List<MBCategory> getSubscribedCategories(long groupId, long userId, int start, int end)
public static int getSubscribedCategoriesCount(long groupId, long userId)
public static void moveCategoriesToTrash(long groupId, long userId) throws PortalException
PortalException
public static MBCategory moveCategory(long categoryId, long parentCategoryId, boolean mergeWithParentCategory) throws PortalException
PortalException
public static MBCategory moveCategoryFromTrash(long userId, long categoryId, long newCategoryId) throws PortalException
PortalException
public static MBCategory moveCategoryToTrash(long userId, long categoryId) throws PortalException
PortalException
public static void restoreCategoryFromTrash(long userId, long categoryId) throws PortalException
PortalException
public static void subscribeCategory(long userId, long groupId, long categoryId) throws PortalException
PortalException
public static void unsubscribeCategory(long userId, long groupId, long categoryId) throws PortalException
PortalException
public static MBCategory updateCategory(long categoryId, long parentCategoryId, String name, String description, String displayStyle, 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 mailingListActive, boolean mergeWithParentCategory, ServiceContext serviceContext) throws PortalException
PortalException
public static MBCategory updateMBCategory(MBCategory mbCategory)
mbCategory
- the message boards categorypublic static MBCategory updateMessageCount(long categoryId)
public static MBCategory updateStatistics(long categoryId)
public static MBCategory updateStatus(long userId, long categoryId, int status) throws PortalException
PortalException
public static MBCategory updateThreadCount(long categoryId)
public static MBCategoryLocalService getService()