com.liferay.announcements.kernel.service

Class AnnouncementsEntryLocalServiceWrapper

Object

com.liferay.announcements.kernel.service.AnnouncementsEntryLocalServiceWrapper

All Implemented Interfaces:

AnnouncementsEntryLocalService, BaseLocalService, PersistedModelLocalService, ServiceWrapper<AnnouncementsEntryLocalService>

public class AnnouncementsEntryLocalServiceWrapper
extends Object
implements AnnouncementsEntryLocalService, ServiceWrapper<AnnouncementsEntryLocalService>

Provides a wrapper for AnnouncementsEntryLocalService.

Author:

Brian Wing Shun Chan

See Also:

AnnouncementsEntryLocalService

{$generated.description}

Constructor Summary

Constructors

Constructor and Description
AnnouncementsEntryLocalServiceWrapper()
AnnouncementsEntryLocalServiceWrapper(AnnouncementsEntryLocalService announcementsEntryLocalService)

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)
AnnouncementsEntryLocalService	getWrappedService()
void	setWrappedService(AnnouncementsEntryLocalService announcementsEntryLocalService)
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 class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

getBasePersistence

Constructor Detail

AnnouncementsEntryLocalServiceWrapper

public AnnouncementsEntryLocalServiceWrapper()

AnnouncementsEntryLocalServiceWrapper

public AnnouncementsEntryLocalServiceWrapper(AnnouncementsEntryLocalService announcementsEntryLocalService)

Method Detail

addAnnouncementsEntry

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

Specified by:

addAnnouncementsEntry in interface AnnouncementsEntryLocalService

Parameters:

announcementsEntry - the announcements entry

Returns:

the announcements entry that was added

addEntry

public 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

Specified by:

addEntry in interface AnnouncementsEntryLocalService

Throws:

PortalException

checkEntries

public void checkEntries()
                  throws PortalException

Specified by:

checkEntries in interface AnnouncementsEntryLocalService

Throws:

PortalException

checkEntries

public void checkEntries(Date startDate,
                         Date endDate)
                  throws PortalException

Specified by:

checkEntries in interface AnnouncementsEntryLocalService

Throws:

PortalException

createAnnouncementsEntry

public AnnouncementsEntry createAnnouncementsEntry(long entryId)

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

Specified by:

createAnnouncementsEntry in interface AnnouncementsEntryLocalService

Parameters:

entryId - the primary key for the new announcements entry

Returns:

the new announcements entry

createPersistedModel

public PersistedModel createPersistedModel(Serializable primaryKeyObj)
                                    throws PortalException

Specified by:

createPersistedModel in interface AnnouncementsEntryLocalService

Specified by:

createPersistedModel in interface PersistedModelLocalService

Throws:

PortalException

deleteAnnouncementsEntry

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

Specified by:

deleteAnnouncementsEntry in interface AnnouncementsEntryLocalService

Parameters:

announcementsEntry - the announcements entry

Returns:

the announcements entry that was removed

deleteAnnouncementsEntry

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

Specified by:

deleteAnnouncementsEntry in interface AnnouncementsEntryLocalService

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

public void deleteEntries(long companyId)

Specified by:

deleteEntries in interface AnnouncementsEntryLocalService

deleteEntries

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

Specified by:

deleteEntries in interface AnnouncementsEntryLocalService

Throws:

PortalException

deleteEntries

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

Specified by:

deleteEntries in interface AnnouncementsEntryLocalService

Throws:

PortalException

deleteEntry

public void deleteEntry(AnnouncementsEntry entry)
                 throws PortalException

Specified by:

deleteEntry in interface AnnouncementsEntryLocalService

Throws:

PortalException

deleteEntry

public void deleteEntry(long entryId)
                 throws PortalException

Specified by:

deleteEntry in interface AnnouncementsEntryLocalService

Throws:

PortalException

deletePersistedModel

public PersistedModel deletePersistedModel(PersistedModel persistedModel)
                                    throws PortalException

Specified by:

deletePersistedModel in interface AnnouncementsEntryLocalService

Specified by:

deletePersistedModel in interface PersistedModelLocalService

Throws:

PortalException

dslQuery

public <T> T dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)

Specified by:

dslQuery in interface AnnouncementsEntryLocalService

Specified by:

dslQuery in interface PersistedModelLocalService

dslQueryCount

public int dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)

Specified by:

dslQueryCount in interface AnnouncementsEntryLocalService

Specified by:

dslQueryCount in interface PersistedModelLocalService

dynamicQuery

public DynamicQuery dynamicQuery()

Specified by:

dynamicQuery in interface AnnouncementsEntryLocalService

dynamicQuery

public <T> List<T> dynamicQuery(DynamicQuery dynamicQuery)

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

Specified by:

dynamicQuery in interface AnnouncementsEntryLocalService

Parameters:

dynamicQuery - the dynamic query

Returns:

the matching rows

dynamicQuery

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

Specified by:

dynamicQuery in interface AnnouncementsEntryLocalService

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

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

Specified by:

dynamicQuery in interface AnnouncementsEntryLocalService

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

public long dynamicQueryCount(DynamicQuery dynamicQuery)

Returns the number of rows matching the dynamic query.

Specified by:

dynamicQueryCount in interface AnnouncementsEntryLocalService

Parameters:

dynamicQuery - the dynamic query

Returns:

the number of rows matching the dynamic query

dynamicQueryCount

public long dynamicQueryCount(DynamicQuery dynamicQuery,
                              Projection projection)

Returns the number of rows matching the dynamic query.

Specified by:

dynamicQueryCount in interface AnnouncementsEntryLocalService

Parameters:

dynamicQuery - the dynamic query

projection - the projection to apply to the query

Returns:

the number of rows matching the dynamic query

fetchAnnouncementsEntry

public AnnouncementsEntry fetchAnnouncementsEntry(long entryId)

Specified by:

fetchAnnouncementsEntry in interface AnnouncementsEntryLocalService

fetchAnnouncementsEntryByUuidAndCompanyId

public AnnouncementsEntry fetchAnnouncementsEntryByUuidAndCompanyId(String uuid,
                                                                    long companyId)

Returns the announcements entry with the matching UUID and company.

Specified by:

fetchAnnouncementsEntryByUuidAndCompanyId in interface AnnouncementsEntryLocalService

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

public ActionableDynamicQuery getActionableDynamicQuery()

Specified by:

getActionableDynamicQuery in interface AnnouncementsEntryLocalService

getAnnouncementsEntries

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

Specified by:

getAnnouncementsEntries in interface AnnouncementsEntryLocalService

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

public int getAnnouncementsEntriesCount()

Returns the number of announcements entries.

Specified by:

getAnnouncementsEntriesCount in interface AnnouncementsEntryLocalService

Returns:

the number of announcements entries

getAnnouncementsEntry

public AnnouncementsEntry getAnnouncementsEntry(long entryId)
                                         throws PortalException

Returns the announcements entry with the primary key.

Specified by:

getAnnouncementsEntry in interface AnnouncementsEntryLocalService

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

public AnnouncementsEntry getAnnouncementsEntryByUuidAndCompanyId(String uuid,
                                                                  long companyId)
                                                           throws PortalException

Returns the announcements entry with the matching UUID and company.

Specified by:

getAnnouncementsEntryByUuidAndCompanyId in interface AnnouncementsEntryLocalService

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

public List<AnnouncementsEntry> getEntries(long userId,
                                           LinkedHashMap<Long,long[]> scopes,
                                           boolean alert,
                                           int flagValue,
                                           int start,
                                           int end)

Specified by:

getEntries in interface AnnouncementsEntryLocalService

getEntries

public 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)

Specified by:

getEntries in interface AnnouncementsEntryLocalService

getEntries

public List<AnnouncementsEntry> getEntries(long companyId,
                                           long classNameId,
                                           long classPK,
                                           boolean alert,
                                           int start,
                                           int end)

Specified by:

getEntries in interface AnnouncementsEntryLocalService

getEntries

public 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)

Specified by:

getEntries in interface AnnouncementsEntryLocalService

getEntriesCount

public int getEntriesCount(long userId,
                           LinkedHashMap<Long,long[]> scopes,
                           boolean alert,
                           int flagValue)

Specified by:

getEntriesCount in interface AnnouncementsEntryLocalService

getEntriesCount

public 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)

Specified by:

getEntriesCount in interface AnnouncementsEntryLocalService

getEntriesCount

public int getEntriesCount(long companyId,
                           long classNameId,
                           long classPK,
                           boolean alert)

Specified by:

getEntriesCount in interface AnnouncementsEntryLocalService

getEntriesCount

public int getEntriesCount(long userId,
                           long classNameId,
                           long[] classPKs,
                           boolean alert,
                           int flagValue)

Specified by:

getEntriesCount in interface AnnouncementsEntryLocalService

getEntriesCount

public 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)

Specified by:

getEntriesCount in interface AnnouncementsEntryLocalService

getEntry

public AnnouncementsEntry getEntry(long entryId)
                            throws PortalException

Specified by:

getEntry in interface AnnouncementsEntryLocalService

Throws:

PortalException

getExportActionableDynamicQuery

public ExportActionableDynamicQuery getExportActionableDynamicQuery(PortletDataContext portletDataContext)

Specified by:

getExportActionableDynamicQuery in interface AnnouncementsEntryLocalService

getIndexableActionableDynamicQuery

public IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()

Specified by:

getIndexableActionableDynamicQuery in interface AnnouncementsEntryLocalService

getOSGiServiceIdentifier

public String getOSGiServiceIdentifier()

Returns the OSGi service identifier.

Specified by:

getOSGiServiceIdentifier in interface AnnouncementsEntryLocalService

Returns:

the OSGi service identifier

getPersistedModel

public PersistedModel getPersistedModel(Serializable primaryKeyObj)
                                 throws PortalException

Specified by:

getPersistedModel in interface AnnouncementsEntryLocalService

Specified by:

getPersistedModel in interface PersistedModelLocalService

Throws:

PortalException

getUserEntries

public List<AnnouncementsEntry> getUserEntries(long userId,
                                               int start,
                                               int end)

Specified by:

getUserEntries in interface AnnouncementsEntryLocalService

getUserEntriesCount

public int getUserEntriesCount(long userId)

Specified by:

getUserEntriesCount in interface AnnouncementsEntryLocalService

updateAnnouncementsEntry

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

Specified by:

updateAnnouncementsEntry in interface AnnouncementsEntryLocalService

Parameters:

announcementsEntry - the announcements entry

Returns:

the announcements entry that was updated

updateEntry

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

Specified by:

updateEntry in interface AnnouncementsEntryLocalService

Throws:

PortalException

getWrappedService

public AnnouncementsEntryLocalService getWrappedService()

Specified by:

getWrappedService in interface ServiceWrapper<AnnouncementsEntryLocalService>

setWrappedService

public void setWrappedService(AnnouncementsEntryLocalService announcementsEntryLocalService)

Specified by:

setWrappedService in interface ServiceWrapper<AnnouncementsEntryLocalService>