Liferay 6.0.5

com.liferay.portlet.announcements.service
Interface AnnouncementsFlagLocalService

All Known Implementing Classes:
AnnouncementsFlagLocalServiceBaseImpl, AnnouncementsFlagLocalServiceImpl, AnnouncementsFlagLocalServiceWrapper

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

The interface for the announcements flag local service.

Never modify or reference this interface directly. Always use AnnouncementsFlagLocalServiceUtil to access the announcements flag local service. Add custom service methods to AnnouncementsFlagLocalServiceImpl and rerun ServiceBuilder to automatically copy the method declarations to this interface.

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:
AnnouncementsFlagLocalServiceUtil, AnnouncementsFlagLocalServiceBaseImpl, AnnouncementsFlagLocalServiceImpl
ServiceBuilder generated this class. Modifications in this class will be overwritten the next time is generated.

Method Summary
 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.
 void deleteAnnouncementsFlag(AnnouncementsFlag announcementsFlag)
          Deletes the announcements flag from the database.
 void deleteAnnouncementsFlag(long flagId)
          Deletes the announcements flag with the primary key from the database.
 void deleteFlag(long flagId)
           
 void deleteFlags(long entryId)
           
 List dynamicQuery(DynamicQuery dynamicQuery)
          Performs a dynamic query on the database and returns the matching rows.
 List dynamicQuery(DynamicQuery dynamicQuery, int start, int end)
          Performs a dynamic query on the database and returns a range of the matching rows.
 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.
 long dynamicQueryCount(DynamicQuery dynamicQuery)
          Counts the number of rows that match the dynamic query.
 AnnouncementsFlag getAnnouncementsFlag(long flagId)
          Gets the announcements flag with the primary key.
 List<AnnouncementsFlag> getAnnouncementsFlags(int start, int end)
          Gets a range of all the announcements flags.
 int getAnnouncementsFlagsCount()
          Gets the number of announcements flags.
 AnnouncementsFlag getFlag(long userId, long entryId, int value)
           
 AnnouncementsFlag updateAnnouncementsFlag(AnnouncementsFlag announcementsFlag)
          Updates the announcements flag in the database.
 AnnouncementsFlag updateAnnouncementsFlag(AnnouncementsFlag announcementsFlag, boolean merge)
          Updates the announcements flag in the database.
 

Method Detail

addAnnouncementsFlag

AnnouncementsFlag addAnnouncementsFlag(AnnouncementsFlag announcementsFlag)
                                       throws SystemException
Adds the announcements flag to the database. Also notifies the appropriate model listeners.

Parameters:
announcementsFlag - the announcements flag to add
Returns:
the announcements flag that was added
Throws:
SystemException - if a system exception occurred

createAnnouncementsFlag

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

void 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 to delete
Throws:
PortalException - if a announcements flag with the primary key could not be found
SystemException - if a system exception occurred

deleteAnnouncementsFlag

void deleteAnnouncementsFlag(AnnouncementsFlag announcementsFlag)
                             throws SystemException
Deletes the announcements flag from the database. Also notifies the appropriate model listeners.

Parameters:
announcementsFlag - the announcements flag to delete
Throws:
SystemException - if a system exception occurred

dynamicQuery

List dynamicQuery(DynamicQuery dynamicQuery)
                  throws SystemException
Performs a dynamic query on the database and returns the matching rows.

Parameters:
dynamicQuery - the dynamic query to search with
Returns:
the matching rows
Throws:
SystemException - if a system exception occurred

dynamicQuery

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 to search with
start - the lower bound of the range of model instances to return
end - the upper bound of the range of model instances to return (not inclusive)
Returns:
the range of matching rows
Throws:
SystemException - if a system exception occurred

dynamicQuery

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 to search with
start - the lower bound of the range of model instances to return
end - the upper bound of the range of model instances to return (not inclusive)
orderByComparator - the comparator to order the results by
Returns:
the ordered range of matching rows
Throws:
SystemException - if a system exception occurred

dynamicQueryCount

long dynamicQueryCount(DynamicQuery dynamicQuery)
                       throws SystemException
Counts the number of rows that match the dynamic query.

Parameters:
dynamicQuery - the dynamic query to search with
Returns:
the number of rows that match the dynamic query
Throws:
SystemException - if a system exception occurred

getAnnouncementsFlag

@Transactional(propagation=SUPPORTS,
               readOnly=true)
AnnouncementsFlag getAnnouncementsFlag(long flagId)
                                       throws PortalException,
                                              SystemException
Gets the announcements flag with the primary key.

Parameters:
flagId - the primary key of the announcements flag to get
Returns:
the announcements flag
Throws:
PortalException - if a announcements flag with the primary key could not be found
SystemException - if a system exception occurred

getAnnouncementsFlags

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<AnnouncementsFlag> getAnnouncementsFlags(int start,
                                                                                       int end)
                                              throws SystemException
Gets 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 to return
end - the upper bound of the range of announcements flags to return (not inclusive)
Returns:
the range of announcements flags
Throws:
SystemException - if a system exception occurred

getAnnouncementsFlagsCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getAnnouncementsFlagsCount()
                               throws SystemException
Gets the number of announcements flags.

Returns:
the number of announcements flags
Throws:
SystemException - if a system exception occurred

updateAnnouncementsFlag

AnnouncementsFlag updateAnnouncementsFlag(AnnouncementsFlag announcementsFlag)
                                          throws SystemException
Updates the announcements flag in the database. Also notifies the appropriate model listeners.

Parameters:
announcementsFlag - the announcements flag to update
Returns:
the announcements flag that was updated
Throws:
SystemException - if a system exception occurred

updateAnnouncementsFlag

AnnouncementsFlag updateAnnouncementsFlag(AnnouncementsFlag announcementsFlag,
                                          boolean merge)
                                          throws SystemException
Updates the announcements flag in the database. Also notifies the appropriate model listeners.

Parameters:
announcementsFlag - the announcements flag to update
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

addFlag

AnnouncementsFlag addFlag(long userId,
                          long entryId,
                          int value)
                          throws SystemException
Throws:
SystemException

deleteFlag

void deleteFlag(long flagId)
                throws PortalException,
                       SystemException
Throws:
PortalException
SystemException

deleteFlags

void deleteFlags(long entryId)
                 throws SystemException
Throws:
SystemException

getFlag

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

Liferay 6.0.5