Interface AnnouncementsEntryLocalService
- All Superinterfaces:
BaseLocalService
,CTService<AnnouncementsEntry>
,PersistedModelLocalService
- All Known Implementing Classes:
AnnouncementsEntryLocalServiceWrapper
- Author:
- Brian Wing Shun Chan
- See Also:
- {$generated.description}
-
Method Summary
Modifier and TypeMethodDescriptionaddAnnouncementsEntry
(AnnouncementsEntry announcementsEntry) Adds the announcements entry to the database.addEntry
(long userId, long classNameId, long classPK, String title, String content, String url, String type, Date displayDate, Date expirationDate, int priority, boolean alert) void
void
checkEntries
(Date startDate, Date endDate) createAnnouncementsEntry
(long entryId) Creates a new announcements entry with the primary key.createPersistedModel
(Serializable primaryKeyObj) deleteAnnouncementsEntry
(long entryId) Deletes the announcements entry with the primary key from the database.deleteAnnouncementsEntry
(AnnouncementsEntry announcementsEntry) Deletes the announcements entry from the database.void
deleteEntries
(long companyId) void
deleteEntries
(long classNameId, long classPK) void
deleteEntries
(long companyId, long classNameId, long classPK) void
deleteEntry
(long entryId) void
deleteEntry
(AnnouncementsEntry entry) deletePersistedModel
(PersistedModel persistedModel) <T> T
dslQuery
(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) int
dslQueryCount
(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) <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.fetchAnnouncementsEntry
(long entryId) fetchAnnouncementsEntryByUuidAndCompanyId
(String uuid, long companyId) Returns the announcements entry with the matching UUID and company.getAnnouncementsEntries
(int start, int end) Returns a range of all the announcements entries.int
Returns the number of announcements entries.getAnnouncementsEntry
(long entryId) Returns the announcements entry with the primary key.getAnnouncementsEntryByUuidAndCompanyId
(String uuid, long companyId) Returns the announcements entry with the matching UUID and company.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) getEntries
(long companyId, long classNameId, long classPK, boolean alert, int start, int end) getEntries
(long userId, LinkedHashMap<Long, long[]> scopes, boolean alert, int flagValue, int start, int end) 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) 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) 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) getEntry
(long entryId) getExportActionableDynamicQuery
(PortletDataContext portletDataContext) Returns the OSGi service identifier.getPersistedModel
(Serializable primaryKeyObj) getUserEntries
(long userId, int start, int end) int
getUserEntriesCount
(long userId) updateAnnouncementsEntry
(AnnouncementsEntry announcementsEntry) Updates the announcements entry in the database or adds it if it does not yet exist.updateEntry
(long entryId, String title, String content, String url, String type, Date displayDate, Date expirationDate, int priority) <R,
E extends Throwable>
RupdateWithUnsafeFunction
(com.liferay.petra.function.UnsafeFunction<CTPersistence<AnnouncementsEntry>, R, E> updateUnsafeFunction) Methods inherited from interface com.liferay.portal.kernel.service.PersistedModelLocalService
fetchPersistedModel, getBasePersistence
-
Method Details
-
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
- Throws:
PortalException
-
checkEntries
- Throws:
PortalException
-
createAnnouncementsEntry
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
- Specified by:
createPersistedModel
in interfacePersistedModelLocalService
- 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
- Throws:
PortalException
-
deleteEntries
- Throws:
PortalException
-
deleteEntry
- Throws:
PortalException
-
deleteEntry
- Throws:
PortalException
-
deletePersistedModel
- Specified by:
deletePersistedModel
in interfacePersistedModelLocalService
- Throws:
PortalException
-
dslQuery
@Transactional(propagation=SUPPORTS, readOnly=true) <T> T dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) - Specified by:
dslQuery
in interfacePersistedModelLocalService
-
dslQueryCount
@Transactional(propagation=SUPPORTS, readOnly=true) int dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) - Specified by:
dslQueryCount
in interfacePersistedModelLocalService
-
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
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
tocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS
will return the full result set. IforderByComparator
is specified, then the query will include the given ORDER BY logic. IforderByComparator
is absent, then the query will include the default ORDER BY logic fromcom.liferay.portlet.announcements.model.impl.AnnouncementsEntryModelImpl
.- Parameters:
dynamicQuery
- the dynamic querystart
- the lower bound of the range of model instancesend
- 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
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
tocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS
will return the full result set. IforderByComparator
is specified, then the query will include the given ORDER BY logic. IforderByComparator
is absent, then the query will include the default ORDER BY logic fromcom.liferay.portlet.announcements.model.impl.AnnouncementsEntryModelImpl
.- Parameters:
dynamicQuery
- the dynamic querystart
- the lower bound of the range of model instancesend
- the upper bound of the range of model instances (not inclusive)orderByComparator
- the comparator to order the results by (optionallynull
)- 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 queryprojection
- 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 UUIDcompanyId
- 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
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
tocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS
will return the full result set. IforderByComparator
is specified, then the query will include the given ORDER BY logic. IforderByComparator
is absent, then the query will include the default ORDER BY logic fromcom.liferay.portlet.announcements.model.impl.AnnouncementsEntryModelImpl
.- Parameters:
start
- the lower bound of the range of announcements entriesend
- the upper bound of the range of announcements entries (not inclusive)- Returns:
- the range of announcements entries
-
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 UUIDcompanyId
- 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 interfacePersistedModelLocalService
- Throws:
PortalException
-
getUserEntries
@Transactional(propagation=SUPPORTS, readOnly=true) List<AnnouncementsEntry> getUserEntries(long userId, int start, int end) -
getUserEntriesCount
-
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
-
getCTPersistence
- Specified by:
getCTPersistence
in interfaceCTService<AnnouncementsEntry>
-
getModelClass
- Specified by:
getModelClass
in interfaceCTService<AnnouncementsEntry>
-
updateWithUnsafeFunction
@Transactional(rollbackFor=java.lang.Throwable.class) <R,E extends Throwable> R updateWithUnsafeFunction(com.liferay.petra.function.UnsafeFunction<CTPersistence<AnnouncementsEntry>, R, throws EE> updateUnsafeFunction) - Specified by:
updateWithUnsafeFunction
in interfaceCTService<AnnouncementsEntry>
- Throws:
E extends Throwable
-