com.liferay.announcements.kernel.service

Interface AnnouncementsFlagLocalService

All Superinterfaces:

BaseLocalService, PersistedModelLocalService

All Known Implementing Classes:

AnnouncementsFlagLocalServiceWrapper

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

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

AnnouncementsFlagLocalServiceUtil, AnnouncementsFlagLocalServiceBaseImpl, AnnouncementsFlagLocalServiceImpl

{$generated.description}

Method Summary

Modifier and Type	Method and Description
AnnouncementsFlag	addAnnouncementsFlag(AnnouncementsFlag announcementsFlag) Adds the announcements flag to the database.
AnnouncementsFlag	addFlag(long userId, long entryId, int value)
AnnouncementsFlag	createAnnouncementsFlag(long flagId) Creates a new announcements flag with the primary key.
AnnouncementsFlag	deleteAnnouncementsFlag(AnnouncementsFlag announcementsFlag) Deletes the announcements flag from the database.
AnnouncementsFlag	deleteAnnouncementsFlag(long flagId) Deletes the announcements flag with the primary key from the database.
void	deleteFlag(AnnouncementsFlag flag)
void	deleteFlag(long flagId)
void	deleteFlags(long entryId)
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.
AnnouncementsFlag	fetchAnnouncementsFlag(long flagId)
ActionableDynamicQuery	getActionableDynamicQuery()
AnnouncementsFlag	getAnnouncementsFlag(long flagId) Returns the announcements flag with the primary key.
List<AnnouncementsFlag>	getAnnouncementsFlags(int start, int end) Returns a range of all the announcements flags.
int	getAnnouncementsFlagsCount() Returns the number of announcements flags.
AnnouncementsFlag	getFlag(long userId, long entryId, int value)
IndexableActionableDynamicQuery	getIndexableActionableDynamicQuery()
String	getOSGiServiceIdentifier() Returns the OSGi service identifier.
PersistedModel	getPersistedModel(Serializable primaryKeyObj)
AnnouncementsFlag	updateAnnouncementsFlag(AnnouncementsFlag announcementsFlag) Updates the announcements flag in the database or adds it if it does not yet exist.

Method Detail

addAnnouncementsFlag

@Indexable(type=REINDEX)
AnnouncementsFlag addAnnouncementsFlag(AnnouncementsFlag announcementsFlag)

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

addFlag

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

createAnnouncementsFlag

@Transactional(enabled=false)
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

@Indexable(type=DELETE)
AnnouncementsFlag deleteAnnouncementsFlag(AnnouncementsFlag announcementsFlag)

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

deleteAnnouncementsFlag

@Indexable(type=DELETE)
AnnouncementsFlag deleteAnnouncementsFlag(long flagId)
                                                           throws PortalException

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

deleteFlag

void deleteFlag(AnnouncementsFlag flag)

deleteFlag

void deleteFlag(long flagId)
         throws PortalException

Throws:

PortalException

deleteFlags

void deleteFlags(long entryId)

deletePersistedModel

PersistedModel deletePersistedModel(PersistedModel persistedModel)
                             throws PortalException

Specified by:

deletePersistedModel in interface PersistedModelLocalService

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

fetchAnnouncementsFlag

@Transactional(propagation=SUPPORTS,
               readOnly=true)
AnnouncementsFlag fetchAnnouncementsFlag(long flagId)

getActionableDynamicQuery

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

getAnnouncementsFlag

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

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

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

Returns:

the range of announcements flags

getAnnouncementsFlagsCount

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

Returns the number of announcements flags.

Returns:

the number of announcements flags

getFlag

@Transactional(propagation=SUPPORTS,
               readOnly=true)
AnnouncementsFlag getFlag(long userId,
                                                                                             long entryId,
                                                                                             int value)
                                                                                      throws PortalException

Throws:

PortalException

getIndexableActionableDynamicQuery

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

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

updateAnnouncementsFlag

@Indexable(type=REINDEX)
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.

Parameters:

announcementsFlag - the announcements flag

Returns:

the announcements flag that was updated