com.liferay.portlet.announcements.service
Interface AnnouncementsEntryLocalService

All Known Implementing Classes:

AnnouncementsEntryLocalServiceBaseImpl, AnnouncementsEntryLocalServiceImpl, AnnouncementsEntryLocalServiceWrapper

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

The interface for the announcements entry local service.

Never modify or reference this interface directly. Always use AnnouncementsEntryLocalServiceUtil to access the announcements entry local service. Add custom service methods to AnnouncementsEntryLocalServiceImpl 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:

AnnouncementsEntryLocalServiceUtil, AnnouncementsEntryLocalServiceBaseImpl, AnnouncementsEntryLocalServiceImpl

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

Method Summary

AnnouncementsEntry	addAnnouncementsEntry(AnnouncementsEntry announcementsEntry) Adds the announcements entry to the database.
AnnouncementsEntry	addEntry(long userId, long classNameId, long classPK, String title, String content, String url, String type, int displayDateMonth, int displayDateDay, int displayDateYear, int displayDateHour, int displayDateMinute, int expirationDateMonth, int expirationDateDay, int expirationDateYear, int expirationDateHour, int expirationDateMinute, int priority, boolean alert)
void	checkEntries()
AnnouncementsEntry	createAnnouncementsEntry(long entryId) Creates a new announcements entry with the primary key.
void	deleteAnnouncementsEntry(AnnouncementsEntry announcementsEntry) Deletes the announcements entry from the database.
void	deleteAnnouncementsEntry(long entryId) Deletes the announcements entry with the primary key from the database.
void	deleteEntry(AnnouncementsEntry entry)
void	deleteEntry(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.
List<AnnouncementsEntry>	getAnnouncementsEntries(int start, int end) Gets a range of all the announcements entries.
int	getAnnouncementsEntriesCount() Gets the number of announcements entries.
AnnouncementsEntry	getAnnouncementsEntry(long entryId) Gets the announcements entry with the primary key.
List<AnnouncementsEntry>	getEntries(long userId, LinkedHashMap<Long,long[]> scopes, boolean alert, int flagValue, int start, int end)
List<AnnouncementsEntry>	getEntries(long userId, LinkedHashMap<Long,long[]> scopes, int displayDateMonth, int displayDateDay, int displayDateYear, int displayDateHour, int displayDateMinute, int expirationDateMonth, int expirationDateDay, int expirationDateYear, int expirationDateHour, int expirationDateMinute, boolean alert, int flagValue, int start, int end)
List<AnnouncementsEntry>	getEntries(long classNameId, long classPK, boolean alert, int start, int end)
List<AnnouncementsEntry>	getEntries(long userId, long classNameId, long[] classPKs, int displayDateMonth, int displayDateDay, int displayDateYear, int displayDateHour, int displayDateMinute, int expirationDateMonth, int expirationDateDay, int expirationDateYear, int expirationDateHour, int expirationDateMinute, boolean alert, int flagValue, int start, int end)
int	getEntriesCount(long userId, LinkedHashMap<Long,long[]> scopes, boolean alert, int flagValue)
int	getEntriesCount(long userId, LinkedHashMap<Long,long[]> scopes, int displayDateMonth, int displayDateDay, int displayDateYear, int displayDateHour, int displayDateMinute, int expirationDateMonth, int expirationDateDay, int expirationDateYear, int expirationDateHour, int expirationDateMinute, boolean alert, int flagValue)
int	getEntriesCount(long classNameId, long classPK, boolean alert)
int	getEntriesCount(long userId, long classNameId, long[] classPKs, boolean alert, int flagValue)
int	getEntriesCount(long userId, long classNameId, long[] classPKs, int displayDateMonth, int displayDateDay, int displayDateYear, int displayDateHour, int displayDateMinute, int expirationDateMonth, int expirationDateDay, int expirationDateYear, int expirationDateHour, int expirationDateMinute, boolean alert, int flagValue)
AnnouncementsEntry	getEntry(long entryId)
List<AnnouncementsEntry>	getUserEntries(long userId, int start, int end)
int	getUserEntriesCount(long userId)
AnnouncementsEntry	updateAnnouncementsEntry(AnnouncementsEntry announcementsEntry) Updates the announcements entry in the database.
AnnouncementsEntry	updateAnnouncementsEntry(AnnouncementsEntry announcementsEntry, boolean merge) Updates the announcements entry in the database.
AnnouncementsEntry	updateEntry(long userId, long entryId, String title, String content, String url, String type, int displayDateMonth, int displayDateDay, int displayDateYear, int displayDateHour, int displayDateMinute, int expirationDateMonth, int expirationDateDay, int expirationDateYear, int expirationDateHour, int expirationDateMinute, int priority)

Method Detail

addAnnouncementsEntry

AnnouncementsEntry addAnnouncementsEntry(AnnouncementsEntry announcementsEntry)
                                         throws SystemException

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

Parameters:

announcementsEntry - the announcements entry to add

Returns:

the announcements entry that was added

Throws:

SystemException - if a system exception occurred

createAnnouncementsEntry

AnnouncementsEntry createAnnouncementsEntry(long entryId)

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

Parameters:

entryId - the primary key for the new announcements entry

Returns:

the new announcements entry

deleteAnnouncementsEntry

void deleteAnnouncementsEntry(long entryId)
                              throws PortalException,
                                     SystemException

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

Parameters:

entryId - the primary key of the announcements entry to delete

Throws:

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

SystemException - if a system exception occurred

deleteAnnouncementsEntry

void deleteAnnouncementsEntry(AnnouncementsEntry announcementsEntry)
                              throws SystemException

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

Parameters:

announcementsEntry - the announcements entry 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

getAnnouncementsEntry

@Transactional(propagation=SUPPORTS,
               readOnly=true)
AnnouncementsEntry getAnnouncementsEntry(long entryId)
                                         throws PortalException,
                                                SystemException

Gets the announcements entry with the primary key.

Parameters:

entryId - the primary key of the announcements entry to get

Returns:

the announcements entry

Throws:

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

SystemException - if a system exception occurred

getAnnouncementsEntries

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<AnnouncementsEntry> getAnnouncementsEntries(int start,
                                                                                          int end)
                                                 throws SystemException

Gets a range of all the announcements entries.

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 entries to return

end - the upper bound of the range of announcements entries to return (not inclusive)

Returns:

the range of announcements entries

Throws:

SystemException - if a system exception occurred

getAnnouncementsEntriesCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getAnnouncementsEntriesCount()
                                 throws SystemException

Gets the number of announcements entries.

Returns:

the number of announcements entries

Throws:

SystemException - if a system exception occurred

updateAnnouncementsEntry

AnnouncementsEntry updateAnnouncementsEntry(AnnouncementsEntry announcementsEntry)
                                            throws SystemException

Updates the announcements entry in the database. Also notifies the appropriate model listeners.

Parameters:

announcementsEntry - the announcements entry to update

Returns:

the announcements entry that was updated

Throws:

SystemException - if a system exception occurred

updateAnnouncementsEntry

AnnouncementsEntry updateAnnouncementsEntry(AnnouncementsEntry announcementsEntry,
                                            boolean merge)
                                            throws SystemException

Updates the announcements entry in the database. Also notifies the appropriate model listeners.

Parameters:

announcementsEntry - the announcements entry to update

merge - whether to merge the announcements entry 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 entry that was updated

Throws:

SystemException - if a system exception occurred

addEntry

AnnouncementsEntry addEntry(long userId,
                            long classNameId,
                            long classPK,
                            String title,
                            String content,
                            String url,
                            String type,
                            int displayDateMonth,
                            int displayDateDay,
                            int displayDateYear,
                            int displayDateHour,
                            int displayDateMinute,
                            int expirationDateMonth,
                            int expirationDateDay,
                            int expirationDateYear,
                            int expirationDateHour,
                            int expirationDateMinute,
                            int priority,
                            boolean alert)
                            throws PortalException,
                                   SystemException

Throws:

PortalException

SystemException

checkEntries

void checkEntries()
                  throws PortalException,
                         SystemException

Throws:

PortalException

SystemException

deleteEntry

void deleteEntry(AnnouncementsEntry entry)
                 throws PortalException,
                        SystemException

Throws:

PortalException

SystemException

deleteEntry

void deleteEntry(long entryId)
                 throws PortalException,
                        SystemException

Throws:

PortalException

SystemException

getEntries

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<AnnouncementsEntry> getEntries(long userId,
                                                                             LinkedHashMap<Long,long[]> scopes,
                                                                             boolean alert,
                                                                             int flagValue,
                                                                             int start,
                                                                             int end)
                                    throws SystemException

Throws:

SystemException

getEntries

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<AnnouncementsEntry> getEntries(long userId,
                                                                             LinkedHashMap<Long,long[]> scopes,
                                                                             int displayDateMonth,
                                                                             int displayDateDay,
                                                                             int displayDateYear,
                                                                             int displayDateHour,
                                                                             int displayDateMinute,
                                                                             int expirationDateMonth,
                                                                             int expirationDateDay,
                                                                             int expirationDateYear,
                                                                             int expirationDateHour,
                                                                             int expirationDateMinute,
                                                                             boolean alert,
                                                                             int flagValue,
                                                                             int start,
                                                                             int end)
                                    throws SystemException

Throws:

SystemException

getEntries

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<AnnouncementsEntry> getEntries(long classNameId,
                                                                             long classPK,
                                                                             boolean alert,
                                                                             int start,
                                                                             int end)
                                    throws SystemException

Throws:

SystemException

getEntries

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<AnnouncementsEntry> getEntries(long userId,
                                                                             long classNameId,
                                                                             long[] classPKs,
                                                                             int displayDateMonth,
                                                                             int displayDateDay,
                                                                             int displayDateYear,
                                                                             int displayDateHour,
                                                                             int displayDateMinute,
                                                                             int expirationDateMonth,
                                                                             int expirationDateDay,
                                                                             int expirationDateYear,
                                                                             int expirationDateHour,
                                                                             int expirationDateMinute,
                                                                             boolean alert,
                                                                             int flagValue,
                                                                             int start,
                                                                             int end)
                                    throws SystemException

Throws:

SystemException

getEntriesCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getEntriesCount(long userId,
                                                             LinkedHashMap<Long,long[]> scopes,
                                                             boolean alert,
                                                             int flagValue)
                    throws SystemException

Throws:

SystemException

getEntriesCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getEntriesCount(long userId,
                                                             LinkedHashMap<Long,long[]> scopes,
                                                             int displayDateMonth,
                                                             int displayDateDay,
                                                             int displayDateYear,
                                                             int displayDateHour,
                                                             int displayDateMinute,
                                                             int expirationDateMonth,
                                                             int expirationDateDay,
                                                             int expirationDateYear,
                                                             int expirationDateHour,
                                                             int expirationDateMinute,
                                                             boolean alert,
                                                             int flagValue)
                    throws SystemException

Throws:

SystemException

getEntriesCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getEntriesCount(long classNameId,
                                                             long classPK,
                                                             boolean alert)
                    throws SystemException

Throws:

SystemException

getEntriesCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getEntriesCount(long userId,
                                                             long classNameId,
                                                             long[] classPKs,
                                                             boolean alert,
                                                             int flagValue)
                    throws SystemException

Throws:

SystemException

getEntriesCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getEntriesCount(long userId,
                                                             long classNameId,
                                                             long[] classPKs,
                                                             int displayDateMonth,
                                                             int displayDateDay,
                                                             int displayDateYear,
                                                             int displayDateHour,
                                                             int displayDateMinute,
                                                             int expirationDateMonth,
                                                             int expirationDateDay,
                                                             int expirationDateYear,
                                                             int expirationDateHour,
                                                             int expirationDateMinute,
                                                             boolean alert,
                                                             int flagValue)
                    throws SystemException

Throws:

SystemException

getEntry

@Transactional(propagation=SUPPORTS,
               readOnly=true)
AnnouncementsEntry getEntry(long entryId)
                            throws PortalException,
                                   SystemException

Throws:

PortalException

SystemException

getUserEntries

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<AnnouncementsEntry> getUserEntries(long userId,
                                                                                 int start,
                                                                                 int end)
                                        throws SystemException

Throws:

SystemException

getUserEntriesCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getUserEntriesCount(long userId)
                        throws SystemException

Throws:

SystemException

updateEntry

AnnouncementsEntry updateEntry(long userId,
                               long entryId,
                               String title,
                               String content,
                               String url,
                               String type,
                               int displayDateMonth,
                               int displayDateDay,
                               int displayDateYear,
                               int displayDateHour,
                               int displayDateMinute,
                               int expirationDateMonth,
                               int expirationDateDay,
                               int expirationDateYear,
                               int expirationDateHour,
                               int expirationDateMinute,
                               int priority)
                               throws PortalException,
                                      SystemException

Throws:

PortalException

SystemException