com.liferay.announcements.kernel.service

Interface AnnouncementsEntryLocalService

All Superinterfaces:

BaseLocalService, PersistedModelLocalService

All Known Implementing Classes:

AnnouncementsEntryLocalServiceWrapper

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

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

AnnouncementsEntryLocalServiceUtil

{$generated.description}

Method Summary

Modifier and Type	Method and Description
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, Date displayDate, Date expirationDate, int priority, boolean alert)
void	checkEntries()
void	checkEntries(Date startDate, Date endDate)
AnnouncementsEntry	createAnnouncementsEntry(long entryId) Creates a new announcements entry with the primary key.
PersistedModel	createPersistedModel(Serializable primaryKeyObj)
AnnouncementsEntry	deleteAnnouncementsEntry(AnnouncementsEntry announcementsEntry) Deletes the announcements entry from the database.
AnnouncementsEntry	deleteAnnouncementsEntry(long entryId) Deletes the announcements entry with the primary key from the database.
void	deleteEntries(long companyId)
void	deleteEntries(long classNameId, long classPK)
void	deleteEntries(long companyId, long classNameId, long classPK)
void	deleteEntry(AnnouncementsEntry entry)
void	deleteEntry(long entryId)
PersistedModel	deletePersistedModel(PersistedModel persistedModel)
<T> T	dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)
int	dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)
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.
AnnouncementsEntry	fetchAnnouncementsEntry(long entryId)
AnnouncementsEntry	fetchAnnouncementsEntryByUuidAndCompanyId(String uuid, long companyId) Returns the announcements entry with the matching UUID and company.
ActionableDynamicQuery	getActionableDynamicQuery()
List<AnnouncementsEntry>	getAnnouncementsEntries(int start, int end) Returns a range of all the announcements entries.
int	getAnnouncementsEntriesCount() Returns the number of announcements entries.
AnnouncementsEntry	getAnnouncementsEntry(long entryId) Returns the announcements entry with the primary key.
AnnouncementsEntry	getAnnouncementsEntryByUuidAndCompanyId(String uuid, long companyId) Returns the announcements entry with the matching UUID and company.
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 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)
List<AnnouncementsEntry>	getEntries(long companyId, long classNameId, long classPK, boolean alert, 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 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)
int	getEntriesCount(long companyId, long classNameId, long classPK, boolean alert)
AnnouncementsEntry	getEntry(long entryId)
ExportActionableDynamicQuery	getExportActionableDynamicQuery(PortletDataContext portletDataContext)
IndexableActionableDynamicQuery	getIndexableActionableDynamicQuery()
String	getOSGiServiceIdentifier() Returns the OSGi service identifier.
PersistedModel	getPersistedModel(Serializable primaryKeyObj)
List<AnnouncementsEntry>	getUserEntries(long userId, int start, int end)
int	getUserEntriesCount(long userId)
AnnouncementsEntry	updateAnnouncementsEntry(AnnouncementsEntry announcementsEntry) Updates the announcements entry in the database or adds it if it does not yet exist.
AnnouncementsEntry	updateEntry(long entryId, String title, String content, String url, String type, Date displayDate, Date expirationDate, int priority)

Methods inherited from interface com.liferay.portal.kernel.service.PersistedModelLocalService

getBasePersistence

Method Detail

addAnnouncementsEntry

@Indexable(type=REINDEX)
AnnouncementsEntry addAnnouncementsEntry(AnnouncementsEntry announcementsEntry)

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

Important: Inspect AnnouncementsEntryLocalServiceImpl 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:

announcementsEntry - the announcements entry

Returns:

the announcements entry that was added

addEntry

AnnouncementsEntry addEntry(long userId,
                            long classNameId,
                            long classPK,
                            String title,
                            String content,
                            String url,
                            String type,
                            Date displayDate,
                            Date expirationDate,
                            int priority,
                            boolean alert)
                     throws PortalException

Throws:

PortalException

checkEntries

void checkEntries()
           throws PortalException

Throws:

PortalException

checkEntries

void checkEntries(Date startDate,
                  Date endDate)
           throws PortalException

Throws:

PortalException

createAnnouncementsEntry

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

createPersistedModel

PersistedModel createPersistedModel(Serializable primaryKeyObj)
                             throws PortalException

Specified by:

createPersistedModel in interface PersistedModelLocalService

Throws:

PortalException

deleteAnnouncementsEntry

@Indexable(type=DELETE)
AnnouncementsEntry deleteAnnouncementsEntry(AnnouncementsEntry announcementsEntry)

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

Important: Inspect AnnouncementsEntryLocalServiceImpl 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:

announcementsEntry - the announcements entry

Returns:

the announcements entry that was removed

deleteAnnouncementsEntry

@Indexable(type=DELETE)
AnnouncementsEntry deleteAnnouncementsEntry(long entryId)
                                                             throws PortalException

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

Important: Inspect AnnouncementsEntryLocalServiceImpl 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:

entryId - the primary key of the announcements entry

Returns:

the announcements entry that was removed

Throws:

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

deleteEntries

void deleteEntries(long companyId)

deleteEntries

void deleteEntries(long classNameId,
                   long classPK)
            throws PortalException

Throws:

PortalException

deleteEntries

void deleteEntries(long companyId,
                   long classNameId,
                   long classPK)
            throws PortalException

Throws:

PortalException

deleteEntry

@SystemEvent(type=1)
void deleteEntry(AnnouncementsEntry entry)
                               throws PortalException

Throws:

PortalException

deleteEntry

void deleteEntry(long entryId)
          throws PortalException

Throws:

PortalException

deletePersistedModel

PersistedModel deletePersistedModel(PersistedModel persistedModel)
                             throws PortalException

Specified by:

deletePersistedModel in interface PersistedModelLocalService

Throws:

PortalException

dslQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
<T> T dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)

Specified by:

dslQuery in interface PersistedModelLocalService

dslQueryCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)

Specified by:

dslQueryCount in interface PersistedModelLocalService

dynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
DynamicQuery dynamicQuery()

dynamicQuery

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

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

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

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

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

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

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

fetchAnnouncementsEntry

@Transactional(propagation=SUPPORTS,
               readOnly=true)
AnnouncementsEntry fetchAnnouncementsEntry(long entryId)

fetchAnnouncementsEntryByUuidAndCompanyId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
AnnouncementsEntry fetchAnnouncementsEntryByUuidAndCompanyId(String uuid,
                                                                                                                                long companyId)

Returns the announcements entry with the matching UUID and company.

Parameters:

uuid - the announcements entry's UUID

companyId - the primary key of the company

Returns:

the matching announcements entry, or null if a matching announcements entry could not be found

getActionableDynamicQuery

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

getAnnouncementsEntries

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

Returns 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 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.AnnouncementsEntryModelImpl.

Parameters:

start - the lower bound of the range of announcements entries

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

Returns:

the range of announcements entries

getAnnouncementsEntriesCount

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

Returns the number of announcements entries.

Returns:

the number of announcements entries

getAnnouncementsEntry

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

Returns the announcements entry with the primary key.

Parameters:

entryId - the primary key of the announcements entry

Returns:

the announcements entry

Throws:

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

getAnnouncementsEntryByUuidAndCompanyId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
AnnouncementsEntry getAnnouncementsEntryByUuidAndCompanyId(String uuid,
                                                                                                                              long companyId)
                                                                                                                       throws PortalException

Returns the announcements entry with the matching UUID and company.

Parameters:

uuid - the announcements entry's UUID

companyId - the primary key of the company

Returns:

the matching announcements entry

Throws:

PortalException - if a matching announcements entry could not be found

getEntries

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

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)

getEntries

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

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)

getEntriesCount

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

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)

getEntriesCount

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

getEntriesCount

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

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)

getEntry

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

Throws:

PortalException

getExportActionableDynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
ExportActionableDynamicQuery getExportActionableDynamicQuery(PortletDataContext portletDataContext)

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

getUserEntries

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

getUserEntriesCount

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

updateAnnouncementsEntry

@Indexable(type=REINDEX)
AnnouncementsEntry updateAnnouncementsEntry(AnnouncementsEntry announcementsEntry)

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

Important: Inspect AnnouncementsEntryLocalServiceImpl 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:

announcementsEntry - the announcements entry

Returns:

the announcements entry that was updated

updateEntry

AnnouncementsEntry updateEntry(long entryId,
                               String title,
                               String content,
                               String url,
                               String type,
                               Date displayDate,
                               Date expirationDate,
                               int priority)
                        throws PortalException

Throws:

PortalException