com.liferay.portlet.announcements.service
Class AnnouncementsFlagLocalServiceUtil

java.lang.Object
  com.liferay.portlet.announcements.service.AnnouncementsFlagLocalServiceUtil

public class AnnouncementsFlagLocalServiceUtil
extends Object

The utility for the announcements flag local service. This utility wraps AnnouncementsFlagLocalServiceImpl and is the primary access point for service operations in application layer code running on the local server.

This is a local service. 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.

See Also:

AnnouncementsFlagLocalService, AnnouncementsFlagLocalServiceBaseImpl, AnnouncementsFlagLocalServiceImpl

ServiceBuilder generated this class. Modifications in this class will be overwritten the next time it is generated.

Constructor Summary

AnnouncementsFlagLocalServiceUtil()

Method Summary

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 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 DynamicQuery	dynamicQuery()
static List	dynamicQuery(DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.
static List	dynamicQuery(DynamicQuery dynamicQuery, int start, int end) Performs a dynamic query on the database and returns a range of the matching rows.
static List	dynamicQuery(DynamicQuery dynamicQuery, int start, int end, OrderByComparator 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 that match the dynamic query.
static AnnouncementsFlag	fetchAnnouncementsFlag(long flagId)
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 String	getBeanIdentifier() Returns the Spring bean ID for this bean.
static AnnouncementsFlag	getFlag(long userId, long entryId, int value)
static PersistedModel	getPersistedModel(Serializable primaryKeyObj)
static AnnouncementsFlagLocalService	getService()
static void	setBeanIdentifier(String beanIdentifier) Sets the Spring bean ID for this bean.
void	setService(AnnouncementsFlagLocalService service) Deprecated.
static AnnouncementsFlag	updateAnnouncementsFlag(AnnouncementsFlag announcementsFlag) Updates the announcements flag in the database or adds it if it does not yet exist.
static AnnouncementsFlag	updateAnnouncementsFlag(AnnouncementsFlag announcementsFlag, boolean merge) Updates the announcements flag in the database or adds it if it does not yet exist.

Methods inherited from class java.lang.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)
                                              throws SystemException

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

Parameters:

announcementsFlag - the announcements flag

Returns:

the announcements flag that was added

Throws:

SystemException - if a system exception occurred

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

deleteAnnouncementsFlag

public static AnnouncementsFlag deleteAnnouncementsFlag(long flagId)
                                                 throws PortalException,
                                                        SystemException

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

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

SystemException - if a system exception occurred

deleteAnnouncementsFlag

public static AnnouncementsFlag deleteAnnouncementsFlag(AnnouncementsFlag announcementsFlag)
                                                 throws SystemException

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

Parameters:

announcementsFlag - the announcements flag

Returns:

the announcements flag that was removed

Throws:

SystemException - if a system exception occurred

dynamicQuery

public static DynamicQuery dynamicQuery()

dynamicQuery

public static List dynamicQuery(DynamicQuery dynamicQuery)
                         throws SystemException

Performs a dynamic query on the database and returns the matching rows.

Parameters:

dynamicQuery - the dynamic query

Returns:

the matching rows

Throws:

SystemException - if a system exception occurred

dynamicQuery

public static List dynamicQuery(DynamicQuery dynamicQuery,
                                int start,
                                int end)
                         throws SystemException

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.

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

Throws:

SystemException - if a system exception occurred

dynamicQuery

public static List dynamicQuery(DynamicQuery dynamicQuery,
                                int start,
                                int end,
                                OrderByComparator orderByComparator)
                         throws SystemException

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.

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

Throws:

SystemException - if a system exception occurred

dynamicQueryCount

public static long dynamicQueryCount(DynamicQuery dynamicQuery)
                              throws SystemException

Returns the number of rows that match the dynamic query.

Parameters:

dynamicQuery - the dynamic query

Returns:

the number of rows that match the dynamic query

Throws:

SystemException - if a system exception occurred

fetchAnnouncementsFlag

public static AnnouncementsFlag fetchAnnouncementsFlag(long flagId)
                                                throws SystemException

Throws:

SystemException

getAnnouncementsFlag

public static AnnouncementsFlag getAnnouncementsFlag(long flagId)
                                              throws PortalException,
                                                     SystemException

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

SystemException - if a system exception occurred

getPersistedModel

public static PersistedModel getPersistedModel(Serializable primaryKeyObj)
                                        throws PortalException,
                                               SystemException

Throws:

PortalException

SystemException

getAnnouncementsFlags

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

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 QueryUtil.ALL_POS will return the full result set.

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

Throws:

SystemException - if a system exception occurred

getAnnouncementsFlagsCount

public static int getAnnouncementsFlagsCount()
                                      throws SystemException

Returns the number of announcements flags.

Returns:

the number of announcements flags

Throws:

SystemException - if a system exception occurred

updateAnnouncementsFlag

public static AnnouncementsFlag updateAnnouncementsFlag(AnnouncementsFlag announcementsFlag)
                                                 throws SystemException

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

Parameters:

announcementsFlag - the announcements flag

Returns:

the announcements flag that was updated

Throws:

SystemException - if a system exception occurred

updateAnnouncementsFlag

public static AnnouncementsFlag updateAnnouncementsFlag(AnnouncementsFlag announcementsFlag,
                                                        boolean merge)
                                                 throws SystemException

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

Parameters:

announcementsFlag - the announcements flag

merge - whether to merge the announcements flag with the current session. See BatchSession.update(com.liferay.portal.kernel.dao.orm.Session, com.liferay.portal.model.BaseModel, boolean) for an explanation.

Returns:

the announcements flag that was updated

Throws:

SystemException - if a system exception occurred

getBeanIdentifier

public static String getBeanIdentifier()

Returns the Spring bean ID for this bean.

Returns:

the Spring bean ID for this bean

setBeanIdentifier

public static void setBeanIdentifier(String beanIdentifier)

Sets the Spring bean ID for this bean.

Parameters:

beanIdentifier - the Spring bean ID for this bean

addFlag

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

Throws:

SystemException

deleteFlag

public static void deleteFlag(AnnouncementsFlag flag)
                       throws SystemException

Throws:

SystemException

deleteFlag

public static void deleteFlag(long flagId)
                       throws PortalException,
                              SystemException

Throws:

PortalException

SystemException

deleteFlags

public static void deleteFlags(long entryId)
                        throws SystemException

Throws:

SystemException

getFlag

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

Throws:

PortalException

SystemException

getService

public static AnnouncementsFlagLocalService getService()

setService

public void setService(AnnouncementsFlagLocalService service)

Deprecated.