com.liferay.message.boards.kernel.service

Class MBDiscussionLocalServiceUtil

Object

com.liferay.message.boards.kernel.service.MBDiscussionLocalServiceUtil

@ProviderType
public class MBDiscussionLocalServiceUtil
extends Object

Provides the local service utility for MBDiscussion. This utility wraps MBDiscussionLocalServiceImpl 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.

Author:

Brian Wing Shun Chan

See Also:

MBDiscussionLocalService, MBDiscussionLocalServiceBaseImpl, MBDiscussionLocalServiceImpl

{$generated.description}

Constructor Summary

Constructors

Constructor and Description
MBDiscussionLocalServiceUtil()

Method Summary

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

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MBDiscussionLocalServiceUtil

public MBDiscussionLocalServiceUtil()

Method Detail

addDiscussion

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

Throws:

PortalException

addDiscussion

@Deprecated
public static 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

public static 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

public static 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

public static 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

public static 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

public static PersistedModel deletePersistedModel(PersistedModel persistedModel)
                                           throws PortalException

Throws:

PortalException

dynamicQuery

public static DynamicQuery dynamicQuery()

dynamicQuery

public static <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

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

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

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

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

public static 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

public static 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

public static MBDiscussion fetchDiscussion(long discussionId)

fetchDiscussion

public static MBDiscussion fetchDiscussion(String className,
                                           long classPK)

fetchMBDiscussion

public static MBDiscussion fetchMBDiscussion(long discussionId)

fetchMBDiscussionByUuidAndGroupId

public static 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

public static MBDiscussion fetchThreadDiscussion(long threadId)

getActionableDynamicQuery

public static ActionableDynamicQuery getActionableDynamicQuery()

getDiscussion

public static MBDiscussion getDiscussion(long discussionId)
                                  throws PortalException

Throws:

PortalException

getDiscussion

public static MBDiscussion getDiscussion(String className,
                                         long classPK)
                                  throws PortalException

Throws:

PortalException

getExportActionableDynamicQuery

public static ExportActionableDynamicQuery getExportActionableDynamicQuery(PortletDataContext portletDataContext)

getIndexableActionableDynamicQuery

public static IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()

getMBDiscussion

public static 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

public static 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

public static 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

public static 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

public static 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

public static int getMBDiscussionsCount()

Returns the number of message boards discussions.

Returns:

the number of message boards discussions

getOSGiServiceIdentifier

public static String getOSGiServiceIdentifier()

Returns the OSGi service identifier.

Returns:

the OSGi service identifier

getPersistedModel

public static PersistedModel getPersistedModel(Serializable primaryKeyObj)
                                        throws PortalException

Throws:

PortalException

getThreadDiscussion

public static MBDiscussion getThreadDiscussion(long threadId)
                                        throws PortalException

Throws:

PortalException

subscribeDiscussion

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

Throws:

PortalException

unsubscribeDiscussion

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

Throws:

PortalException

updateMBDiscussion

public static 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

getService

public static MBDiscussionLocalService getService()