com.liferay.announcements.kernel.service

Class AnnouncementsFlagLocalServiceUtil

Object

com.liferay.announcements.kernel.service.AnnouncementsFlagLocalServiceUtil

public class AnnouncementsFlagLocalServiceUtil
extends Object

Provides the local service utility for AnnouncementsFlag. This utility wraps com.liferay.portlet.announcements.service.impl.AnnouncementsFlagLocalServiceImpl and is an 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:

AnnouncementsFlagLocalService

{$generated.description}

Constructor Summary

Constructors

Constructor and Description
AnnouncementsFlagLocalServiceUtil()

Method Summary

Modifier and Type	Method and Description
static AnnouncementsFlag	addAnnouncementsFlag(AnnouncementsFlag announcementsFlag) Adds the announcements flag to the database.
static AnnouncementsFlag	addFlag(long userId, long entryId, int value)
static AnnouncementsFlag	createAnnouncementsFlag(long flagId) Creates a new announcements flag with the primary key.
static PersistedModel	createPersistedModel(Serializable primaryKeyObj)
static AnnouncementsFlag	deleteAnnouncementsFlag(AnnouncementsFlag announcementsFlag) Deletes the announcements flag from the database.
static AnnouncementsFlag	deleteAnnouncementsFlag(long flagId) Deletes the announcements flag with the primary key from the database.
static void	deleteFlag(AnnouncementsFlag flag)
static void	deleteFlag(long flagId)
static void	deleteFlags(long entryId)
static PersistedModel	deletePersistedModel(PersistedModel persistedModel)
static <T> T	dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)
static int	dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)
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 AnnouncementsFlag	fetchAnnouncementsFlag(long flagId)
static ActionableDynamicQuery	getActionableDynamicQuery()
static AnnouncementsFlag	getAnnouncementsFlag(long flagId) Returns the announcements flag with the primary key.
static List<AnnouncementsFlag>	getAnnouncementsFlags(int start, int end) Returns a range of all the announcements flags.
static int	getAnnouncementsFlagsCount() Returns the number of announcements flags.
static AnnouncementsFlag	getFlag(long userId, long entryId, int value)
static IndexableActionableDynamicQuery	getIndexableActionableDynamicQuery()
static String	getOSGiServiceIdentifier() Returns the OSGi service identifier.
static PersistedModel	getPersistedModel(Serializable primaryKeyObj)
static AnnouncementsFlagLocalService	getService()
static AnnouncementsFlag	updateAnnouncementsFlag(AnnouncementsFlag announcementsFlag) Updates the announcements flag 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

AnnouncementsFlagLocalServiceUtil

public AnnouncementsFlagLocalServiceUtil()

Method Detail

addAnnouncementsFlag

public static AnnouncementsFlag addAnnouncementsFlag(AnnouncementsFlag announcementsFlag)

Adds the announcements flag to the database. Also notifies the appropriate model listeners.

Important: Inspect AnnouncementsFlagLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.

Parameters:

announcementsFlag - the announcements flag

Returns:

the announcements flag that was added

addFlag

public static AnnouncementsFlag addFlag(long userId,
                                        long entryId,
                                        int value)

createAnnouncementsFlag

public static AnnouncementsFlag createAnnouncementsFlag(long flagId)

Creates a new announcements flag with the primary key. Does not add the announcements flag to the database.

Parameters:

flagId - the primary key for the new announcements flag

Returns:

the new announcements flag

createPersistedModel

public static PersistedModel createPersistedModel(Serializable primaryKeyObj)
                                           throws PortalException

Throws:

PortalException

deleteAnnouncementsFlag

public static AnnouncementsFlag deleteAnnouncementsFlag(AnnouncementsFlag announcementsFlag)

Deletes the announcements flag from the database. Also notifies the appropriate model listeners.

Important: Inspect AnnouncementsFlagLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.

Parameters:

announcementsFlag - the announcements flag

Returns:

the announcements flag that was removed

deleteAnnouncementsFlag

public static AnnouncementsFlag deleteAnnouncementsFlag(long flagId)
                                                 throws PortalException

Deletes the announcements flag with the primary key from the database. Also notifies the appropriate model listeners.

Important: Inspect AnnouncementsFlagLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.

Parameters:

flagId - the primary key of the announcements flag

Returns:

the announcements flag that was removed

Throws:

PortalException - if a announcements flag with the primary key could not be found

deleteFlag

public static void deleteFlag(AnnouncementsFlag flag)

deleteFlag

public static void deleteFlag(long flagId)
                       throws PortalException

Throws:

PortalException

deleteFlags

public static void deleteFlags(long entryId)

deletePersistedModel

public static PersistedModel deletePersistedModel(PersistedModel persistedModel)
                                           throws PortalException

Throws:

PortalException

dslQuery

public static <T> T dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)

dslQueryCount

public static int dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)

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 com.liferay.portal.kernel.dao.orm.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, then the query will include the default ORDER BY logic from com.liferay.portlet.announcements.model.impl.AnnouncementsFlagModelImpl.

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 com.liferay.portal.kernel.dao.orm.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, then the query will include the default ORDER BY logic from com.liferay.portlet.announcements.model.impl.AnnouncementsFlagModelImpl.

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

fetchAnnouncementsFlag

public static AnnouncementsFlag fetchAnnouncementsFlag(long flagId)

getActionableDynamicQuery

public static ActionableDynamicQuery getActionableDynamicQuery()

getAnnouncementsFlag

public static AnnouncementsFlag getAnnouncementsFlag(long flagId)
                                              throws PortalException

Returns the announcements flag with the primary key.

Parameters:

flagId - the primary key of the announcements flag

Returns:

the announcements flag

Throws:

PortalException - if a announcements flag with the primary key could not be found

getAnnouncementsFlags

public static List<AnnouncementsFlag> getAnnouncementsFlags(int start,
                                                            int end)

Returns a range of all the announcements flags.

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 com.liferay.portal.kernel.dao.orm.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, then the query will include the default ORDER BY logic from com.liferay.portlet.announcements.model.impl.AnnouncementsFlagModelImpl.

Parameters:

start - the lower bound of the range of announcements flags

end - the upper bound of the range of announcements flags (not inclusive)

Returns:

the range of announcements flags

getAnnouncementsFlagsCount

public static int getAnnouncementsFlagsCount()

Returns the number of announcements flags.

Returns:

the number of announcements flags

getFlag

public static AnnouncementsFlag getFlag(long userId,
                                        long entryId,
                                        int value)
                                 throws PortalException

Throws:

PortalException

getIndexableActionableDynamicQuery

public static IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()

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

updateAnnouncementsFlag

public static AnnouncementsFlag updateAnnouncementsFlag(AnnouncementsFlag announcementsFlag)

Updates the announcements flag in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

Important: Inspect AnnouncementsFlagLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.

Parameters:

announcementsFlag - the announcements flag

Returns:

the announcements flag that was updated

getService

public static AnnouncementsFlagLocalService getService()