com.liferay.message.boards.kernel.service

Interface MBThreadLocalService

All Superinterfaces:

BaseLocalService, PersistedModelLocalService

All Known Implementing Classes:

MBThreadLocalServiceWrapper

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

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

MBThreadLocalServiceUtil, MBThreadLocalServiceBaseImpl, MBThreadLocalServiceImpl

{$generated.description}

Method Summary

Modifier and Type	Method and Description
MBThread	addMBThread(MBThread mbThread) Adds the message boards thread to the database.
MBThread	addThread(long categoryId, MBMessage message, ServiceContext serviceContext)
MBThread	createMBThread(long threadId) Creates a new message boards thread with the primary key.
MBThread	deleteMBThread(long threadId) Deletes the message boards thread with the primary key from the database.
MBThread	deleteMBThread(MBThread mbThread) Deletes the message boards thread from the database.
PersistedModel	deletePersistedModel(PersistedModel persistedModel)
void	deleteThread(long threadId)
void	deleteThread(MBThread thread)
void	deleteThreads(long groupId, long categoryId)
void	deleteThreads(long groupId, long categoryId, boolean includeTrashedEntries)
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.
MBThread	fetchMBThread(long threadId)
MBThread	fetchMBThreadByUuidAndGroupId(String uuid, long groupId) Returns the message boards thread matching the UUID and group.
MBThread	fetchThread(long threadId)
ActionableDynamicQuery	getActionableDynamicQuery()
int	getCategoryThreadsCount(long groupId, long categoryId, int status)
ExportActionableDynamicQuery	getExportActionableDynamicQuery(PortletDataContext portletDataContext)
List<MBThread>	getGroupThreads(long groupId, long userId, boolean subscribed, boolean includeAnonymous, QueryDefinition<MBThread> queryDefinition)
List<MBThread>	getGroupThreads(long groupId, long userId, boolean subscribed, QueryDefinition<MBThread> queryDefinition)
List<MBThread>	getGroupThreads(long groupId, long userId, QueryDefinition<MBThread> queryDefinition)
List<MBThread>	getGroupThreads(long groupId, QueryDefinition<MBThread> queryDefinition)
int	getGroupThreadsCount(long groupId, long userId, boolean subscribed, boolean includeAnonymous, QueryDefinition<MBThread> queryDefinition)
int	getGroupThreadsCount(long groupId, long userId, boolean subscribed, QueryDefinition<MBThread> queryDefinition)
int	getGroupThreadsCount(long groupId, long userId, QueryDefinition<MBThread> queryDefinition)
int	getGroupThreadsCount(long groupId, QueryDefinition<MBThread> queryDefinition)
IndexableActionableDynamicQuery	getIndexableActionableDynamicQuery()
MBThread	getMBThread(long threadId) Returns the message boards thread with the primary key.
MBThread	getMBThreadByUuidAndGroupId(String uuid, long groupId) Returns the message boards thread matching the UUID and group.
List<MBThread>	getMBThreads(int start, int end) Returns a range of all the message boards threads.
List<MBThread>	getMBThreadsByUuidAndCompanyId(String uuid, long companyId) Returns all the message boards threads matching the UUID and company.
List<MBThread>	getMBThreadsByUuidAndCompanyId(String uuid, long companyId, int start, int end, OrderByComparator<MBThread> orderByComparator) Returns a range of message boards threads matching the UUID and company.
int	getMBThreadsCount() Returns the number of message boards threads.
List<MBThread>	getNoAssetThreads()
String	getOSGiServiceIdentifier() Returns the OSGi service identifier.
PersistedModel	getPersistedModel(Serializable primaryKeyObj)
List<MBThread>	getPriorityThreads(long categoryId, double priority)
List<MBThread>	getPriorityThreads(long categoryId, double priority, boolean inherit)
MBThread	getThread(long threadId)
List<MBThread>	getThreads(long groupId, long categoryId, int status, int start, int end)
int	getThreadsCount(long groupId, long categoryId, int status)
boolean	hasAnswerMessage(long threadId)
void	incrementViewCounter(long threadId, int increment)
void	moveDependentsToTrash(long groupId, long threadId, long trashEntryId)
MBThread	moveThread(long groupId, long categoryId, long threadId)
MBThread	moveThreadFromTrash(long userId, long categoryId, long threadId)
void	moveThreadsToTrash(long groupId, long userId)
MBThread	moveThreadToTrash(long userId, long threadId)
MBThread	moveThreadToTrash(long userId, MBThread thread)
void	restoreDependentsFromTrash(long groupId, long threadId)
void	restoreDependentsFromTrash(long groupId, long threadId, long trashEntryId) Deprecated. As of 7.0.0, replaced by restoreDependentsFromTrash(long, long)
void	restoreThreadFromTrash(long userId, long threadId)
Hits	search(long groupId, long userId, long creatorUserId, int status, int start, int end)
Hits	search(long groupId, long userId, long creatorUserId, long startDate, long endDate, int status, int start, int end)
MBThread	splitThread(long userId, long messageId, String subject, ServiceContext serviceContext)
MBThread	updateMBThread(MBThread mbThread) Updates the message boards thread in the database or adds it if it does not yet exist.
MBThread	updateMessageCount(long threadId)
void	updateQuestion(long threadId, boolean question)
MBThread	updateStatus(long userId, long threadId, int status)

Method Detail

addMBThread

@Indexable(type=REINDEX)
MBThread addMBThread(MBThread mbThread)

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

Parameters:

mbThread - the message boards thread

Returns:

the message boards thread that was added

addThread

MBThread addThread(long categoryId,
                   MBMessage message,
                   ServiceContext serviceContext)
            throws PortalException

Throws:

PortalException

createMBThread

@Transactional(enabled=false)
MBThread createMBThread(long threadId)

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

Parameters:

threadId - the primary key for the new message boards thread

Returns:

the new message boards thread

deleteMBThread

@Indexable(type=DELETE)
MBThread deleteMBThread(long threadId)
                                         throws PortalException

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

Parameters:

threadId - the primary key of the message boards thread

Returns:

the message boards thread that was removed

Throws:

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

deleteMBThread

@Indexable(type=DELETE)
MBThread deleteMBThread(MBThread mbThread)

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

Parameters:

mbThread - the message boards thread

Returns:

the message boards thread that was removed

deletePersistedModel

PersistedModel deletePersistedModel(PersistedModel persistedModel)
                             throws PortalException

Specified by:

deletePersistedModel in interface PersistedModelLocalService

Throws:

PortalException

deleteThread

void deleteThread(long threadId)
           throws PortalException

Throws:

PortalException

deleteThread

@SystemEvent(action=1,
             type=1)
void deleteThread(MBThread thread)
                                                       throws PortalException

Throws:

PortalException

deleteThreads

void deleteThreads(long groupId,
                   long categoryId)
            throws PortalException

Throws:

PortalException

deleteThreads

void deleteThreads(long groupId,
                   long categoryId,
                   boolean includeTrashedEntries)
            throws PortalException

Throws:

PortalException

dynamicQuery

DynamicQuery dynamicQuery()

dynamicQuery

<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

<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 MBThreadModelImpl. 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

<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 MBThreadModelImpl. 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

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

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

fetchMBThread

@Transactional(propagation=SUPPORTS,
               readOnly=true)
MBThread fetchMBThread(long threadId)

fetchMBThreadByUuidAndGroupId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
MBThread fetchMBThreadByUuidAndGroupId(String uuid,
                                                                                                          long groupId)

Returns the message boards thread matching the UUID and group.

Parameters:

uuid - the message boards thread's UUID

groupId - the primary key of the group

Returns:

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

fetchThread

@Transactional(propagation=SUPPORTS,
               readOnly=true)
MBThread fetchThread(long threadId)

getActionableDynamicQuery

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

getCategoryThreadsCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getCategoryThreadsCount(long groupId,
                                                                                               long categoryId,
                                                                                               int status)

getExportActionableDynamicQuery

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

getGroupThreads

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<MBThread> getGroupThreads(long groupId,
                                                                                                  long userId,
                                                                                                  boolean subscribed,
                                                                                                  boolean includeAnonymous,
                                                                                                  QueryDefinition<MBThread> queryDefinition)

getGroupThreads

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<MBThread> getGroupThreads(long groupId,
                                                                                                  long userId,
                                                                                                  boolean subscribed,
                                                                                                  QueryDefinition<MBThread> queryDefinition)

getGroupThreads

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<MBThread> getGroupThreads(long groupId,
                                                                                                  long userId,
                                                                                                  QueryDefinition<MBThread> queryDefinition)

getGroupThreads

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<MBThread> getGroupThreads(long groupId,
                                                                                                  QueryDefinition<MBThread> queryDefinition)

getGroupThreadsCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getGroupThreadsCount(long groupId,
                                                                                            long userId,
                                                                                            boolean subscribed,
                                                                                            boolean includeAnonymous,
                                                                                            QueryDefinition<MBThread> queryDefinition)

getGroupThreadsCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getGroupThreadsCount(long groupId,
                                                                                            long userId,
                                                                                            boolean subscribed,
                                                                                            QueryDefinition<MBThread> queryDefinition)

getGroupThreadsCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getGroupThreadsCount(long groupId,
                                                                                            long userId,
                                                                                            QueryDefinition<MBThread> queryDefinition)

getGroupThreadsCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getGroupThreadsCount(long groupId,
                                                                                            QueryDefinition<MBThread> queryDefinition)

getIndexableActionableDynamicQuery

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

getMBThread

@Transactional(propagation=SUPPORTS,
               readOnly=true)
MBThread getMBThread(long threadId)
                                                                                 throws PortalException

Returns the message boards thread with the primary key.

Parameters:

threadId - the primary key of the message boards thread

Returns:

the message boards thread

Throws:

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

getMBThreadByUuidAndGroupId

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

Returns the message boards thread matching the UUID and group.

Parameters:

uuid - the message boards thread's UUID

groupId - the primary key of the group

Returns:

the matching message boards thread

Throws:

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

getMBThreads

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

Returns a range of all the message boards threads.

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 MBThreadModelImpl. 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 threads

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

Returns:

the range of message boards threads

getMBThreadsByUuidAndCompanyId

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

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

Parameters:

uuid - the UUID of the message boards threads

companyId - the primary key of the company

Returns:

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

getMBThreadsByUuidAndCompanyId

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

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

Parameters:

uuid - the UUID of the message boards threads

companyId - the primary key of the company

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

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

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

Returns:

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

getMBThreadsCount

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

Returns the number of message boards threads.

Returns:

the number of message boards threads

getNoAssetThreads

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<MBThread> getNoAssetThreads()

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

getPriorityThreads

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<MBThread> getPriorityThreads(long categoryId,
                                                                                                     double priority)
                                                                                              throws PortalException

Throws:

PortalException

getPriorityThreads

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<MBThread> getPriorityThreads(long categoryId,
                                                                                                     double priority,
                                                                                                     boolean inherit)
                                                                                              throws PortalException

Throws:

PortalException

getThread

@Transactional(propagation=SUPPORTS,
               readOnly=true)
MBThread getThread(long threadId)
                                                                               throws PortalException

Throws:

PortalException

getThreads

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<MBThread> getThreads(long groupId,
                                                                                             long categoryId,
                                                                                             int status,
                                                                                             int start,
                                                                                             int end)

getThreadsCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getThreadsCount(long groupId,
                                                                                       long categoryId,
                                                                                       int status)

hasAnswerMessage

@Transactional(propagation=SUPPORTS,
               readOnly=true)
boolean hasAnswerMessage(long threadId)

incrementViewCounter

@BufferedIncrement(configuration="MBThread",
                   incrementClass=NumberIncrement.class)
void incrementViewCounter(long threadId,
                                                                                                                                int increment)
                                                                                                                         throws PortalException

Throws:

PortalException

moveDependentsToTrash

void moveDependentsToTrash(long groupId,
                           long threadId,
                           long trashEntryId)
                    throws PortalException

Throws:

PortalException

moveThread

MBThread moveThread(long groupId,
                    long categoryId,
                    long threadId)
             throws PortalException

Throws:

PortalException

moveThreadFromTrash

MBThread moveThreadFromTrash(long userId,
                             long categoryId,
                             long threadId)
                      throws PortalException

Throws:

PortalException

moveThreadsToTrash

void moveThreadsToTrash(long groupId,
                        long userId)
                 throws PortalException

Throws:

PortalException

moveThreadToTrash

MBThread moveThreadToTrash(long userId,
                           long threadId)
                    throws PortalException

Throws:

PortalException

moveThreadToTrash

MBThread moveThreadToTrash(long userId,
                           MBThread thread)
                    throws PortalException

Throws:

PortalException

restoreDependentsFromTrash

void restoreDependentsFromTrash(long groupId,
                                long threadId)
                         throws PortalException

Throws:

PortalException

restoreDependentsFromTrash

@Deprecated
void restoreDependentsFromTrash(long groupId,
                                            long threadId,
                                            long trashEntryId)
                                     throws PortalException

Deprecated. As of 7.0.0, replaced by restoreDependentsFromTrash(long, long)

Throws:

PortalException

restoreThreadFromTrash

void restoreThreadFromTrash(long userId,
                            long threadId)
                     throws PortalException

Throws:

PortalException

search

@Transactional(propagation=SUPPORTS,
               readOnly=true)
Hits search(long groupId,
                                                                               long userId,
                                                                               long creatorUserId,
                                                                               int status,
                                                                               int start,
                                                                               int end)
                                                                        throws PortalException

Throws:

PortalException

search

@Transactional(propagation=SUPPORTS,
               readOnly=true)
Hits search(long groupId,
                                                                               long userId,
                                                                               long creatorUserId,
                                                                               long startDate,
                                                                               long endDate,
                                                                               int status,
                                                                               int start,
                                                                               int end)
                                                                        throws PortalException

Throws:

PortalException

splitThread

MBThread splitThread(long userId,
                     long messageId,
                     String subject,
                     ServiceContext serviceContext)
              throws PortalException

Throws:

PortalException

updateMBThread

@Indexable(type=REINDEX)
MBThread updateMBThread(MBThread mbThread)

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

Parameters:

mbThread - the message boards thread

Returns:

the message boards thread that was updated

updateMessageCount

MBThread updateMessageCount(long threadId)

updateQuestion

void updateQuestion(long threadId,
                    boolean question)
             throws PortalException

Throws:

PortalException

updateStatus

MBThread updateStatus(long userId,
                      long threadId,
                      int status)
               throws PortalException

Throws:

PortalException