com.liferay.message.boards.kernel.service

Interface MBDiscussionLocalService

All Superinterfaces:

BaseLocalService, PersistedModelLocalService

All Known Implementing Classes:

MBDiscussionLocalServiceWrapper

@ProviderType
 @Transactional(isolation=PORTAL,
               rollbackFor={PortalException.class,SystemException.class})
public interface MBDiscussionLocalService
extends BaseLocalService, PersistedModelLocalService

Provides the local service interface for MBDiscussion. 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.

Author:

Brian Wing Shun Chan

See Also:

MBDiscussionLocalServiceUtil, MBDiscussionLocalServiceBaseImpl, MBDiscussionLocalServiceImpl

{$generated.description}

Method Summary

Modifier and Type	Method and Description
MBDiscussion	addDiscussion(long userId, long groupId, long classNameId, long classPK, long threadId, ServiceContext serviceContext)
MBDiscussion	addDiscussion(long userId, long classNameId, long classPK, long threadId, ServiceContext serviceContext) Deprecated. As of Wilberforce (7.0.x), replaced by addDiscussion(long, long, long, long, long, ServiceContext)
MBDiscussion	addMBDiscussion(MBDiscussion mbDiscussion) Adds the message boards discussion to the database.
MBDiscussion	createMBDiscussion(long discussionId) Creates a new message boards discussion with the primary key.
MBDiscussion	deleteMBDiscussion(long discussionId) Deletes the message boards discussion with the primary key from the database.
MBDiscussion	deleteMBDiscussion(MBDiscussion mbDiscussion) Deletes the message boards discussion 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.
MBDiscussion	fetchDiscussion(long discussionId)
MBDiscussion	fetchDiscussion(String className, long classPK)
MBDiscussion	fetchMBDiscussion(long discussionId)
MBDiscussion	fetchMBDiscussionByUuidAndGroupId(String uuid, long groupId) Returns the message boards discussion matching the UUID and group.
MBDiscussion	fetchThreadDiscussion(long threadId)
ActionableDynamicQuery	getActionableDynamicQuery()
MBDiscussion	getDiscussion(long discussionId)
MBDiscussion	getDiscussion(String className, long classPK)
ExportActionableDynamicQuery	getExportActionableDynamicQuery(PortletDataContext portletDataContext)
IndexableActionableDynamicQuery	getIndexableActionableDynamicQuery()
MBDiscussion	getMBDiscussion(long discussionId) Returns the message boards discussion with the primary key.
MBDiscussion	getMBDiscussionByUuidAndGroupId(String uuid, long groupId) Returns the message boards discussion matching the UUID and group.
List<MBDiscussion>	getMBDiscussions(int start, int end) Returns a range of all the message boards discussions.
List<MBDiscussion>	getMBDiscussionsByUuidAndCompanyId(String uuid, long companyId) Returns all the message boards discussions matching the UUID and company.
List<MBDiscussion>	getMBDiscussionsByUuidAndCompanyId(String uuid, long companyId, int start, int end, OrderByComparator<MBDiscussion> orderByComparator) Returns a range of message boards discussions matching the UUID and company.
int	getMBDiscussionsCount() Returns the number of message boards discussions.
String	getOSGiServiceIdentifier() Returns the OSGi service identifier.
PersistedModel	getPersistedModel(Serializable primaryKeyObj)
MBDiscussion	getThreadDiscussion(long threadId)
void	subscribeDiscussion(long userId, long groupId, String className, long classPK)
void	unsubscribeDiscussion(long userId, String className, long classPK)
MBDiscussion	updateMBDiscussion(MBDiscussion mbDiscussion) Updates the message boards discussion in the database or adds it if it does not yet exist.

Method Detail

addDiscussion

MBDiscussion addDiscussion(long userId,
                           long groupId,
                           long classNameId,
                           long classPK,
                           long threadId,
                           ServiceContext serviceContext)
                    throws PortalException

Throws:

PortalException

addDiscussion

@Deprecated
MBDiscussion addDiscussion(long userId,
                                       long classNameId,
                                       long classPK,
                                       long threadId,
                                       ServiceContext serviceContext)
                                throws PortalException

Deprecated. As of Wilberforce (7.0.x), replaced by addDiscussion(long, long, long, long, long, ServiceContext)

Throws:

PortalException

addMBDiscussion

@Indexable(type=REINDEX)
MBDiscussion addMBDiscussion(MBDiscussion mbDiscussion)

Adds the message boards discussion to the database. Also notifies the appropriate model listeners.

Parameters:

mbDiscussion - the message boards discussion

Returns:

the message boards discussion that was added

createMBDiscussion

@Transactional(enabled=false)
MBDiscussion createMBDiscussion(long discussionId)

Creates a new message boards discussion with the primary key. Does not add the message boards discussion to the database.

Parameters:

discussionId - the primary key for the new message boards discussion

Returns:

the new message boards discussion

deleteMBDiscussion

@Indexable(type=DELETE)
MBDiscussion deleteMBDiscussion(long discussionId)
                                                 throws PortalException

Deletes the message boards discussion with the primary key from the database. Also notifies the appropriate model listeners.

Parameters:

discussionId - the primary key of the message boards discussion

Returns:

the message boards discussion that was removed

Throws:

PortalException - if a message boards discussion with the primary key could not be found

deleteMBDiscussion

@Indexable(type=DELETE)
MBDiscussion deleteMBDiscussion(MBDiscussion mbDiscussion)

Deletes the message boards discussion from the database. Also notifies the appropriate model listeners.

Parameters:

mbDiscussion - the message boards discussion

Returns:

the message boards discussion that was removed

deletePersistedModel

PersistedModel deletePersistedModel(PersistedModel persistedModel)
                             throws PortalException

Specified by:

deletePersistedModel in interface PersistedModelLocalService

Throws:

PortalException

dynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
DynamicQuery dynamicQuery()

dynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
<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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
<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 MBDiscussionModelImpl. 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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
<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 MBDiscussionModelImpl. 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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

fetchDiscussion

@Transactional(propagation=SUPPORTS,
               readOnly=true)
MBDiscussion fetchDiscussion(long discussionId)

fetchDiscussion

@Transactional(propagation=SUPPORTS,
               readOnly=true)
MBDiscussion fetchDiscussion(String className,
                                                                                                long classPK)

fetchMBDiscussion

@Transactional(propagation=SUPPORTS,
               readOnly=true)
MBDiscussion fetchMBDiscussion(long discussionId)

fetchMBDiscussionByUuidAndGroupId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
MBDiscussion fetchMBDiscussionByUuidAndGroupId(String uuid,
                                                                                                                  long groupId)

Returns the message boards discussion matching the UUID and group.

Parameters:

uuid - the message boards discussion's UUID

groupId - the primary key of the group

Returns:

the matching message boards discussion, or null if a matching message boards discussion could not be found

fetchThreadDiscussion

@Transactional(propagation=SUPPORTS,
               readOnly=true)
MBDiscussion fetchThreadDiscussion(long threadId)

getActionableDynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
ActionableDynamicQuery getActionableDynamicQuery()

getDiscussion

@Transactional(propagation=SUPPORTS,
               readOnly=true)
MBDiscussion getDiscussion(long discussionId)
                                                                                       throws PortalException

Throws:

PortalException

getDiscussion

@Transactional(propagation=SUPPORTS,
               readOnly=true)
MBDiscussion getDiscussion(String className,
                                                                                              long classPK)
                                                                                       throws PortalException

Throws:

PortalException

getExportActionableDynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
ExportActionableDynamicQuery getExportActionableDynamicQuery(PortletDataContext portletDataContext)

getIndexableActionableDynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()

getMBDiscussion

@Transactional(propagation=SUPPORTS,
               readOnly=true)
MBDiscussion getMBDiscussion(long discussionId)
                                                                                         throws PortalException

Returns the message boards discussion with the primary key.

Parameters:

discussionId - the primary key of the message boards discussion

Returns:

the message boards discussion

Throws:

PortalException - if a message boards discussion with the primary key could not be found

getMBDiscussionByUuidAndGroupId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
MBDiscussion getMBDiscussionByUuidAndGroupId(String uuid,
                                                                                                                long groupId)
                                                                                                         throws PortalException

Returns the message boards discussion matching the UUID and group.

Parameters:

uuid - the message boards discussion's UUID

groupId - the primary key of the group

Returns:

the matching message boards discussion

Throws:

PortalException - if a matching message boards discussion could not be found

getMBDiscussions

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<MBDiscussion> getMBDiscussions(int start,
                                                                                                       int end)

Returns a range of all the message boards discussions.

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 MBDiscussionModelImpl. 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 discussions

end - the upper bound of the range of message boards discussions (not inclusive)

Returns:

the range of message boards discussions

getMBDiscussionsByUuidAndCompanyId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<MBDiscussion> getMBDiscussionsByUuidAndCompanyId(String uuid,
                                                                                                                         long companyId)

Returns all the message boards discussions matching the UUID and company.

Parameters:

uuid - the UUID of the message boards discussions

companyId - the primary key of the company

Returns:

the matching message boards discussions, or an empty list if no matches were found

getMBDiscussionsByUuidAndCompanyId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<MBDiscussion> getMBDiscussionsByUuidAndCompanyId(String uuid,
                                                                                                                         long companyId,
                                                                                                                         int start,
                                                                                                                         int end,
                                                                                                                         OrderByComparator<MBDiscussion> orderByComparator)

Returns a range of message boards discussions matching the UUID and company.

Parameters:

uuid - the UUID of the message boards discussions

companyId - the primary key of the company

start - the lower bound of the range of message boards discussions

end - the upper bound of the range of message boards discussions (not inclusive)

orderByComparator - the comparator to order the results by (optionally null)

Returns:

the range of matching message boards discussions, or an empty list if no matches were found

getMBDiscussionsCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getMBDiscussionsCount()

Returns the number of message boards discussions.

Returns:

the number of message boards discussions

getOSGiServiceIdentifier

String getOSGiServiceIdentifier()

Returns the OSGi service identifier.

Returns:

the OSGi service identifier

getPersistedModel

@Transactional(propagation=SUPPORTS,
               readOnly=true)
PersistedModel getPersistedModel(Serializable primaryKeyObj)
                                                                                             throws PortalException

Specified by:

getPersistedModel in interface PersistedModelLocalService

Throws:

PortalException

getThreadDiscussion

@Transactional(propagation=SUPPORTS,
               readOnly=true)
MBDiscussion getThreadDiscussion(long threadId)
                                                                                             throws PortalException

Throws:

PortalException

subscribeDiscussion

void subscribeDiscussion(long userId,
                         long groupId,
                         String className,
                         long classPK)
                  throws PortalException

Throws:

PortalException

unsubscribeDiscussion

void unsubscribeDiscussion(long userId,
                           String className,
                           long classPK)
                    throws PortalException

Throws:

PortalException

updateMBDiscussion

@Indexable(type=REINDEX)
MBDiscussion updateMBDiscussion(MBDiscussion mbDiscussion)

Updates the message boards discussion in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

Parameters:

mbDiscussion - the message boards discussion

Returns:

the message boards discussion that was updated