public class AnnouncementsEntryLocalServiceUtil
extends Object
com.liferay.portlet.announcements.service.impl.AnnouncementsEntryLocalServiceImpl
and
is an access point for service operations in application layer code running
on the local server. 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.AnnouncementsEntryLocalService
Constructor and Description |
---|
AnnouncementsEntryLocalServiceUtil() |
Modifier and Type | Method and Description |
---|---|
static AnnouncementsEntry |
addAnnouncementsEntry(AnnouncementsEntry announcementsEntry)
Adds the announcements entry to the database.
|
static AnnouncementsEntry |
addEntry(long userId,
long classNameId,
long classPK,
String title,
String content,
String url,
String type,
Date displayDate,
Date expirationDate,
int priority,
boolean alert) |
static void |
checkEntries() |
static void |
checkEntries(Date startDate,
Date endDate) |
static AnnouncementsEntry |
createAnnouncementsEntry(long entryId)
Creates a new announcements entry with the primary key.
|
static PersistedModel |
createPersistedModel(Serializable primaryKeyObj) |
static AnnouncementsEntry |
deleteAnnouncementsEntry(AnnouncementsEntry announcementsEntry)
Deletes the announcements entry from the database.
|
static AnnouncementsEntry |
deleteAnnouncementsEntry(long entryId)
Deletes the announcements entry with the primary key from the database.
|
static void |
deleteEntries(long companyId) |
static void |
deleteEntries(long classNameId,
long classPK) |
static void |
deleteEntries(long companyId,
long classNameId,
long classPK) |
static void |
deleteEntry(AnnouncementsEntry entry) |
static void |
deleteEntry(long entryId) |
static PersistedModel |
deletePersistedModel(PersistedModel persistedModel) |
static <T> T |
dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) |
static int |
dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) |
static DynamicQuery |
dynamicQuery() |
static <T> List<T> |
dynamicQuery(DynamicQuery dynamicQuery)
Performs a dynamic query on the database and returns the matching rows.
|
static <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.
|
static <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.
|
static long |
dynamicQueryCount(DynamicQuery dynamicQuery)
Returns the number of rows matching the dynamic query.
|
static long |
dynamicQueryCount(DynamicQuery dynamicQuery,
Projection projection)
Returns the number of rows matching the dynamic query.
|
static AnnouncementsEntry |
fetchAnnouncementsEntry(long entryId) |
static AnnouncementsEntry |
fetchAnnouncementsEntryByUuidAndCompanyId(String uuid,
long companyId)
Returns the announcements entry with the matching UUID and company.
|
static ActionableDynamicQuery |
getActionableDynamicQuery() |
static List<AnnouncementsEntry> |
getAnnouncementsEntries(int start,
int end)
Returns a range of all the announcements entries.
|
static int |
getAnnouncementsEntriesCount()
Returns the number of announcements entries.
|
static AnnouncementsEntry |
getAnnouncementsEntry(long entryId)
Returns the announcements entry with the primary key.
|
static AnnouncementsEntry |
getAnnouncementsEntryByUuidAndCompanyId(String uuid,
long companyId)
Returns the announcements entry with the matching UUID and company.
|
static List<AnnouncementsEntry> |
getEntries(long userId,
LinkedHashMap<Long,long[]> scopes,
boolean alert,
int flagValue,
int start,
int end) |
static 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) |
static 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) |
static List<AnnouncementsEntry> |
getEntries(long companyId,
long classNameId,
long classPK,
boolean alert,
int start,
int end) |
static int |
getEntriesCount(long userId,
LinkedHashMap<Long,long[]> scopes,
boolean alert,
int flagValue) |
static 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) |
static int |
getEntriesCount(long userId,
long classNameId,
long[] classPKs,
boolean alert,
int flagValue) |
static 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) |
static int |
getEntriesCount(long companyId,
long classNameId,
long classPK,
boolean alert) |
static AnnouncementsEntry |
getEntry(long entryId) |
static ExportActionableDynamicQuery |
getExportActionableDynamicQuery(PortletDataContext portletDataContext) |
static IndexableActionableDynamicQuery |
getIndexableActionableDynamicQuery() |
static String |
getOSGiServiceIdentifier()
Returns the OSGi service identifier.
|
static PersistedModel |
getPersistedModel(Serializable primaryKeyObj) |
static AnnouncementsEntryLocalService |
getService() |
static List<AnnouncementsEntry> |
getUserEntries(long userId,
int start,
int end) |
static int |
getUserEntriesCount(long userId) |
static AnnouncementsEntry |
updateAnnouncementsEntry(AnnouncementsEntry announcementsEntry)
Updates the announcements entry in the database or adds it if it does not yet exist.
|
static AnnouncementsEntry |
updateEntry(long entryId,
String title,
String content,
String url,
String type,
Date displayDate,
Date expirationDate,
int priority) |
public static AnnouncementsEntry addAnnouncementsEntry(AnnouncementsEntry announcementsEntry)
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.
announcementsEntry
- the announcements entrypublic static 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
PortalException
public static void checkEntries() throws PortalException
PortalException
public static void checkEntries(Date startDate, Date endDate) throws PortalException
PortalException
public static AnnouncementsEntry createAnnouncementsEntry(long entryId)
entryId
- the primary key for the new announcements entrypublic static PersistedModel createPersistedModel(Serializable primaryKeyObj) throws PortalException
PortalException
public static AnnouncementsEntry deleteAnnouncementsEntry(AnnouncementsEntry announcementsEntry)
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.
announcementsEntry
- the announcements entrypublic static AnnouncementsEntry deleteAnnouncementsEntry(long entryId) throws PortalException
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.
entryId
- the primary key of the announcements entryPortalException
- if a announcements entry with the primary key could not be foundpublic static void deleteEntries(long companyId)
public static void deleteEntries(long classNameId, long classPK) throws PortalException
PortalException
public static void deleteEntries(long companyId, long classNameId, long classPK) throws PortalException
PortalException
public static void deleteEntry(AnnouncementsEntry entry) throws PortalException
PortalException
public static void deleteEntry(long entryId) throws PortalException
PortalException
public static PersistedModel deletePersistedModel(PersistedModel persistedModel) throws PortalException
PortalException
public static <T> T dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)
public static int dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)
public static DynamicQuery dynamicQuery()
public static <T> List<T> dynamicQuery(DynamicQuery dynamicQuery)
dynamicQuery
- the dynamic querypublic static <T> List<T> dynamicQuery(DynamicQuery dynamicQuery, int start, int end)
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
.
dynamicQuery
- the dynamic querystart
- the lower bound of the range of model instancesend
- the upper bound of the range of model instances (not inclusive)public static <T> List<T> dynamicQuery(DynamicQuery dynamicQuery, int start, int end, OrderByComparator<T> orderByComparator)
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
.
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 (optionally null
)public static long dynamicQueryCount(DynamicQuery dynamicQuery)
dynamicQuery
- the dynamic querypublic static long dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection)
dynamicQuery
- the dynamic queryprojection
- the projection to apply to the querypublic static AnnouncementsEntry fetchAnnouncementsEntry(long entryId)
public static AnnouncementsEntry fetchAnnouncementsEntryByUuidAndCompanyId(String uuid, long companyId)
uuid
- the announcements entry's UUIDcompanyId
- the primary key of the companynull
if a matching announcements entry could not be foundpublic static ActionableDynamicQuery getActionableDynamicQuery()
public static List<AnnouncementsEntry> getAnnouncementsEntries(int start, int end)
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
.
start
- the lower bound of the range of announcements entriesend
- the upper bound of the range of announcements entries (not inclusive)public static int getAnnouncementsEntriesCount()
public static AnnouncementsEntry getAnnouncementsEntry(long entryId) throws PortalException
entryId
- the primary key of the announcements entryPortalException
- if a announcements entry with the primary key could not be foundpublic static AnnouncementsEntry getAnnouncementsEntryByUuidAndCompanyId(String uuid, long companyId) throws PortalException
uuid
- the announcements entry's UUIDcompanyId
- the primary key of the companyPortalException
- if a matching announcements entry could not be foundpublic static List<AnnouncementsEntry> getEntries(long userId, LinkedHashMap<Long,long[]> scopes, boolean alert, int flagValue, int start, int end)
public static 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)
public static List<AnnouncementsEntry> getEntries(long companyId, long classNameId, long classPK, boolean alert, int start, int end)
public static 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)
public static int getEntriesCount(long userId, LinkedHashMap<Long,long[]> scopes, boolean alert, int flagValue)
public static 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)
public static int getEntriesCount(long companyId, long classNameId, long classPK, boolean alert)
public static int getEntriesCount(long userId, long classNameId, long[] classPKs, boolean alert, int flagValue)
public static 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)
public static AnnouncementsEntry getEntry(long entryId) throws PortalException
PortalException
public static ExportActionableDynamicQuery getExportActionableDynamicQuery(PortletDataContext portletDataContext)
public static IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()
public static String getOSGiServiceIdentifier()
public static PersistedModel getPersistedModel(Serializable primaryKeyObj) throws PortalException
PortalException
public static List<AnnouncementsEntry> getUserEntries(long userId, int start, int end)
public static int getUserEntriesCount(long userId)
public static AnnouncementsEntry updateAnnouncementsEntry(AnnouncementsEntry announcementsEntry)
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.
announcementsEntry
- the announcements entrypublic static AnnouncementsEntry updateEntry(long entryId, String title, String content, String url, String type, Date displayDate, Date expirationDate, int priority) throws PortalException
PortalException
public static AnnouncementsEntryLocalService getService()