@ProviderType @Transactional(isolation=PORTAL, rollbackFor={PortalException.class,SystemException.class}) public interface MBCategoryLocalService extends BaseLocalService, PersistedModelLocalService
MBCategoryLocalServiceUtil
,
MBCategoryLocalServiceBaseImpl
,
MBCategoryLocalServiceImpl
Modifier and Type | Method and Description |
---|---|
MBCategory |
addCategory(long userId,
long parentCategoryId,
String name,
String description,
ServiceContext serviceContext) |
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) |
void |
addCategoryResources(long categoryId,
boolean addGroupPermissions,
boolean addGuestPermissions) |
void |
addCategoryResources(long categoryId,
ModelPermissions modelPermissions) |
void |
addCategoryResources(MBCategory category,
boolean addGroupPermissions,
boolean addGuestPermissions) |
void |
addCategoryResources(MBCategory category,
ModelPermissions modelPermissions) |
MBCategory |
addMBCategory(MBCategory mbCategory)
Adds the message boards category to the database.
|
MBCategory |
createMBCategory(long categoryId)
Creates a new message boards category with the primary key.
|
void |
deleteCategories(long groupId) |
void |
deleteCategory(long categoryId) |
void |
deleteCategory(MBCategory category) |
void |
deleteCategory(MBCategory category,
boolean includeTrashedEntries) |
MBCategory |
deleteMBCategory(long categoryId)
Deletes the message boards category with the primary key from the database.
|
MBCategory |
deleteMBCategory(MBCategory mbCategory)
Deletes the message boards category 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.
|
MBCategory |
fetchMBCategory(long categoryId) |
MBCategory |
fetchMBCategoryByUuidAndGroupId(String uuid,
long groupId)
Returns the message boards category matching the UUID and group.
|
ActionableDynamicQuery |
getActionableDynamicQuery() |
List<MBCategory> |
getCategories(long groupId) |
List<MBCategory> |
getCategories(long groupId,
int status) |
List<MBCategory> |
getCategories(long groupId,
long[] parentCategoryIds,
int start,
int end) |
List<MBCategory> |
getCategories(long groupId,
long[] parentCategoryIds,
int status,
int start,
int end) |
List<MBCategory> |
getCategories(long groupId,
long[] excludedCategoryIds,
long[] parentCategoryIds,
int status,
int start,
int end) |
List<MBCategory> |
getCategories(long groupId,
long parentCategoryId,
int start,
int end) |
List<MBCategory> |
getCategories(long groupId,
long parentCategoryId,
int status,
int start,
int end) |
List<MBCategory> |
getCategories(long groupId,
long excludedCategoryId,
long parentCategoryId,
int status,
int start,
int end) |
List<Object> |
getCategoriesAndThreads(long groupId,
long categoryId) |
List<Object> |
getCategoriesAndThreads(long groupId,
long categoryId,
int status) |
List<Object> |
getCategoriesAndThreads(long groupId,
long categoryId,
int status,
int start,
int end) |
int |
getCategoriesAndThreadsCount(long groupId,
long categoryId) |
int |
getCategoriesAndThreadsCount(long groupId,
long categoryId,
int status) |
int |
getCategoriesCount(long groupId) |
int |
getCategoriesCount(long groupId,
int status) |
int |
getCategoriesCount(long groupId,
long parentCategoryId) |
int |
getCategoriesCount(long groupId,
long[] parentCategoryIds) |
int |
getCategoriesCount(long groupId,
long[] parentCategoryIds,
int status) |
int |
getCategoriesCount(long groupId,
long[] excludedCategoryIds,
long[] parentCategoryIds,
int status) |
int |
getCategoriesCount(long groupId,
long parentCategoryId,
int status) |
int |
getCategoriesCount(long groupId,
long excludedCategoryId,
long parentCategoryId,
int status) |
MBCategory |
getCategory(long categoryId) |
List<MBCategory> |
getCompanyCategories(long companyId,
int start,
int end) |
int |
getCompanyCategoriesCount(long companyId) |
ExportActionableDynamicQuery |
getExportActionableDynamicQuery(PortletDataContext portletDataContext) |
IndexableActionableDynamicQuery |
getIndexableActionableDynamicQuery() |
List<MBCategory> |
getMBCategories(int start,
int end)
Returns a range of all the message boards categories.
|
List<MBCategory> |
getMBCategoriesByUuidAndCompanyId(String uuid,
long companyId)
Returns all the message boards categories matching the UUID and company.
|
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.
|
int |
getMBCategoriesCount()
Returns the number of message boards categories.
|
MBCategory |
getMBCategory(long categoryId)
Returns the message boards category with the primary key.
|
MBCategory |
getMBCategoryByUuidAndGroupId(String uuid,
long groupId)
Returns the message boards category matching the UUID and group.
|
String |
getOSGiServiceIdentifier()
Returns the OSGi service identifier.
|
PersistedModel |
getPersistedModel(Serializable primaryKeyObj) |
List<Long> |
getSubcategoryIds(List<Long> categoryIds,
long groupId,
long categoryId) |
List<MBCategory> |
getSubscribedCategories(long groupId,
long userId,
int start,
int end) |
int |
getSubscribedCategoriesCount(long groupId,
long userId) |
void |
moveCategoriesToTrash(long groupId,
long userId) |
MBCategory |
moveCategory(long categoryId,
long parentCategoryId,
boolean mergeWithParentCategory) |
MBCategory |
moveCategoryFromTrash(long userId,
long categoryId,
long newCategoryId) |
MBCategory |
moveCategoryToTrash(long userId,
long categoryId) |
void |
restoreCategoryFromTrash(long userId,
long categoryId) |
void |
subscribeCategory(long userId,
long groupId,
long categoryId) |
void |
unsubscribeCategory(long userId,
long groupId,
long categoryId) |
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) |
MBCategory |
updateMBCategory(MBCategory mbCategory)
Updates the message boards category in the database or adds it if it does not yet exist.
|
MBCategory |
updateMessageCount(long categoryId) |
MBCategory |
updateStatistics(long categoryId) |
MBCategory |
updateStatus(long userId,
long categoryId,
int status) |
MBCategory |
updateThreadCount(long categoryId) |
MBCategory addCategory(long userId, long parentCategoryId, String name, String description, ServiceContext serviceContext) throws PortalException
PortalException
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
void addCategoryResources(long categoryId, boolean addGroupPermissions, boolean addGuestPermissions) throws PortalException
PortalException
void addCategoryResources(long categoryId, ModelPermissions modelPermissions) throws PortalException
PortalException
void addCategoryResources(MBCategory category, boolean addGroupPermissions, boolean addGuestPermissions) throws PortalException
PortalException
void addCategoryResources(MBCategory category, ModelPermissions modelPermissions) throws PortalException
PortalException
@Indexable(type=REINDEX) MBCategory addMBCategory(MBCategory mbCategory)
mbCategory
- the message boards category@Transactional(enabled=false) MBCategory createMBCategory(long categoryId)
categoryId
- the primary key for the new message boards categoryvoid deleteCategories(long groupId) throws PortalException
PortalException
void deleteCategory(long categoryId) throws PortalException
PortalException
void deleteCategory(MBCategory category) throws PortalException
PortalException
@SystemEvent(action=1, type=1) void deleteCategory(MBCategory category, boolean includeTrashedEntries) throws PortalException
PortalException
@Indexable(type=DELETE) 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 found@Indexable(type=DELETE) MBCategory deleteMBCategory(MBCategory mbCategory)
mbCategory
- the message boards categoryPersistedModel deletePersistedModel(PersistedModel persistedModel) throws PortalException
deletePersistedModel
in interface PersistedModelLocalService
PortalException
DynamicQuery dynamicQuery()
<T> List<T> dynamicQuery(DynamicQuery dynamicQuery)
dynamicQuery
- the dynamic query<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)<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
)long dynamicQueryCount(DynamicQuery dynamicQuery)
dynamicQuery
- the dynamic querylong dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection)
dynamicQuery
- the dynamic queryprojection
- the projection to apply to the query@Transactional(propagation=SUPPORTS, readOnly=true) MBCategory fetchMBCategory(long categoryId)
@Transactional(propagation=SUPPORTS, readOnly=true) 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 found@Transactional(propagation=SUPPORTS, readOnly=true) ActionableDynamicQuery getActionableDynamicQuery()
@Transactional(propagation=SUPPORTS, readOnly=true) List<MBCategory> getCategories(long groupId)
@Transactional(propagation=SUPPORTS, readOnly=true) List<MBCategory> getCategories(long groupId, int status)
@Transactional(propagation=SUPPORTS, readOnly=true) List<MBCategory> getCategories(long groupId, long parentCategoryId, int start, int end)
@Transactional(propagation=SUPPORTS, readOnly=true) List<MBCategory> getCategories(long groupId, long parentCategoryId, int status, int start, int end)
@Transactional(propagation=SUPPORTS, readOnly=true) List<MBCategory> getCategories(long groupId, long excludedCategoryId, long parentCategoryId, int status, int start, int end)
@Transactional(propagation=SUPPORTS, readOnly=true) List<MBCategory> getCategories(long groupId, long[] parentCategoryIds, int start, int end)
@Transactional(propagation=SUPPORTS, readOnly=true) List<MBCategory> getCategories(long groupId, long[] parentCategoryIds, int status, int start, int end)
@Transactional(propagation=SUPPORTS, readOnly=true) List<MBCategory> getCategories(long groupId, long[] excludedCategoryIds, long[] parentCategoryIds, int status, int start, int end)
@Transactional(propagation=SUPPORTS, readOnly=true) List<Object> getCategoriesAndThreads(long groupId, long categoryId)
@Transactional(propagation=SUPPORTS, readOnly=true) List<Object> getCategoriesAndThreads(long groupId, long categoryId, int status)
@Transactional(propagation=SUPPORTS, readOnly=true) List<Object> getCategoriesAndThreads(long groupId, long categoryId, int status, int start, int end)
@Transactional(propagation=SUPPORTS, readOnly=true) int getCategoriesAndThreadsCount(long groupId, long categoryId)
@Transactional(propagation=SUPPORTS, readOnly=true) int getCategoriesAndThreadsCount(long groupId, long categoryId, int status)
@Transactional(propagation=SUPPORTS, readOnly=true) int getCategoriesCount(long groupId)
@Transactional(propagation=SUPPORTS, readOnly=true) int getCategoriesCount(long groupId, int status)
@Transactional(propagation=SUPPORTS, readOnly=true) int getCategoriesCount(long groupId, long parentCategoryId)
@Transactional(propagation=SUPPORTS, readOnly=true) int getCategoriesCount(long groupId, long parentCategoryId, int status)
@Transactional(propagation=SUPPORTS, readOnly=true) int getCategoriesCount(long groupId, long excludedCategoryId, long parentCategoryId, int status)
@Transactional(propagation=SUPPORTS, readOnly=true) int getCategoriesCount(long groupId, long[] parentCategoryIds)
@Transactional(propagation=SUPPORTS, readOnly=true) int getCategoriesCount(long groupId, long[] parentCategoryIds, int status)
@Transactional(propagation=SUPPORTS, readOnly=true) int getCategoriesCount(long groupId, long[] excludedCategoryIds, long[] parentCategoryIds, int status)
@Transactional(propagation=SUPPORTS, readOnly=true) MBCategory getCategory(long categoryId) throws PortalException
PortalException
@Transactional(propagation=SUPPORTS, readOnly=true) List<MBCategory> getCompanyCategories(long companyId, int start, int end)
@Transactional(propagation=SUPPORTS, readOnly=true) int getCompanyCategoriesCount(long companyId)
@Transactional(propagation=SUPPORTS, readOnly=true) ExportActionableDynamicQuery getExportActionableDynamicQuery(PortletDataContext portletDataContext)
@Transactional(propagation=SUPPORTS, readOnly=true) IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()
@Transactional(propagation=SUPPORTS, readOnly=true) 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)@Transactional(propagation=SUPPORTS, readOnly=true) List<MBCategory> getMBCategoriesByUuidAndCompanyId(String uuid, long companyId)
uuid
- the UUID of the message boards categoriescompanyId
- the primary key of the company@Transactional(propagation=SUPPORTS, readOnly=true) 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
)@Transactional(propagation=SUPPORTS, readOnly=true) int getMBCategoriesCount()
@Transactional(propagation=SUPPORTS, readOnly=true) 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 found@Transactional(propagation=SUPPORTS, readOnly=true) 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 foundString getOSGiServiceIdentifier()
@Transactional(propagation=SUPPORTS, readOnly=true) PersistedModel getPersistedModel(Serializable primaryKeyObj) throws PortalException
getPersistedModel
in interface PersistedModelLocalService
PortalException
@Transactional(propagation=SUPPORTS, readOnly=true) List<Long> getSubcategoryIds(List<Long> categoryIds, long groupId, long categoryId)
@Transactional(propagation=SUPPORTS, readOnly=true) List<MBCategory> getSubscribedCategories(long groupId, long userId, int start, int end)
@Transactional(propagation=SUPPORTS, readOnly=true) int getSubscribedCategoriesCount(long groupId, long userId)
void moveCategoriesToTrash(long groupId, long userId) throws PortalException
PortalException
MBCategory moveCategory(long categoryId, long parentCategoryId, boolean mergeWithParentCategory) throws PortalException
PortalException
MBCategory moveCategoryFromTrash(long userId, long categoryId, long newCategoryId) throws PortalException
PortalException
MBCategory moveCategoryToTrash(long userId, long categoryId) throws PortalException
PortalException
void restoreCategoryFromTrash(long userId, long categoryId) throws PortalException
PortalException
void subscribeCategory(long userId, long groupId, long categoryId) throws PortalException
PortalException
void unsubscribeCategory(long userId, long groupId, long categoryId) throws PortalException
PortalException
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
@Indexable(type=REINDEX) MBCategory updateMBCategory(MBCategory mbCategory)
mbCategory
- the message boards categoryMBCategory updateMessageCount(long categoryId)
MBCategory updateStatistics(long categoryId)
MBCategory updateStatus(long userId, long categoryId, int status) throws PortalException
PortalException
MBCategory updateThreadCount(long categoryId)