com.liferay.announcements.kernel.service.AnnouncementsEntryLocalServiceUtil Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of com.liferay.portal.kernel Show documentation
Show all versions of com.liferay.portal.kernel Show documentation
Contains interfaces for the portal services. Interfaces are only loaded by the global class loader and are shared by all plugins.
/**
* Copyright (c) 2000-present Liferay, Inc. All rights reserved.
*
* This library is free software; you can redistribute it and/or modify it under
* the terms of the GNU Lesser General Public License as published by the Free
* Software Foundation; either version 2.1 of the License, or (at your option)
* any later version.
*
* This library is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
* FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
* details.
*/
package com.liferay.announcements.kernel.service;
import aQute.bnd.annotation.ProviderType;
import com.liferay.portal.kernel.bean.PortalBeanLocatorUtil;
import com.liferay.portal.kernel.util.ReferenceRegistry;
/**
* Provides the local service utility for AnnouncementsEntry. This utility wraps
* {@link com.liferay.portlet.announcements.service.impl.AnnouncementsEntryLocalServiceImpl} and is the
* primary 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.
*
* @author Brian Wing Shun Chan
* @see AnnouncementsEntryLocalService
* @see com.liferay.portlet.announcements.service.base.AnnouncementsEntryLocalServiceBaseImpl
* @see com.liferay.portlet.announcements.service.impl.AnnouncementsEntryLocalServiceImpl
* @generated
*/
@ProviderType
public class AnnouncementsEntryLocalServiceUtil {
/*
* NOTE FOR DEVELOPERS:
*
* Never modify this class directly. Add custom service methods to {@link com.liferay.portlet.announcements.service.impl.AnnouncementsEntryLocalServiceImpl} and rerun ServiceBuilder to regenerate this class.
*/
/**
* Adds the announcements entry to the database. Also notifies the appropriate model listeners.
*
* @param announcementsEntry the announcements entry
* @return the announcements entry that was added
*/
public static com.liferay.announcements.kernel.model.AnnouncementsEntry addAnnouncementsEntry(
com.liferay.announcements.kernel.model.AnnouncementsEntry announcementsEntry) {
return getService().addAnnouncementsEntry(announcementsEntry);
}
public static com.liferay.announcements.kernel.model.AnnouncementsEntry addEntry(
long userId, long classNameId, long classPK, java.lang.String title,
java.lang.String content, java.lang.String url, java.lang.String type,
int displayDateMonth, int displayDateDay, int displayDateYear,
int displayDateHour, int displayDateMinute, boolean displayImmediately,
int expirationDateMonth, int expirationDateDay, int expirationDateYear,
int expirationDateHour, int expirationDateMinute, int priority,
boolean alert)
throws com.liferay.portal.kernel.exception.PortalException {
return getService()
.addEntry(userId, classNameId, classPK, title, content, url,
type, displayDateMonth, displayDateDay, displayDateYear,
displayDateHour, displayDateMinute, displayImmediately,
expirationDateMonth, expirationDateDay, expirationDateYear,
expirationDateHour, expirationDateMinute, priority, alert);
}
public static void checkEntries()
throws com.liferay.portal.kernel.exception.PortalException {
getService().checkEntries();
}
/**
* Creates a new announcements entry with the primary key. Does not add the announcements entry to the database.
*
* @param entryId the primary key for the new announcements entry
* @return the new announcements entry
*/
public static com.liferay.announcements.kernel.model.AnnouncementsEntry createAnnouncementsEntry(
long entryId) {
return getService().createAnnouncementsEntry(entryId);
}
/**
* Deletes the announcements entry from the database. Also notifies the appropriate model listeners.
*
* @param announcementsEntry the announcements entry
* @return the announcements entry that was removed
*/
public static com.liferay.announcements.kernel.model.AnnouncementsEntry deleteAnnouncementsEntry(
com.liferay.announcements.kernel.model.AnnouncementsEntry announcementsEntry) {
return getService().deleteAnnouncementsEntry(announcementsEntry);
}
/**
* Deletes the announcements entry with the primary key from the database. Also notifies the appropriate model listeners.
*
* @param entryId the primary key of the announcements entry
* @return the announcements entry that was removed
* @throws PortalException if a announcements entry with the primary key could not be found
*/
public static com.liferay.announcements.kernel.model.AnnouncementsEntry deleteAnnouncementsEntry(
long entryId)
throws com.liferay.portal.kernel.exception.PortalException {
return getService().deleteAnnouncementsEntry(entryId);
}
public static void deleteEntry(
com.liferay.announcements.kernel.model.AnnouncementsEntry entry)
throws com.liferay.portal.kernel.exception.PortalException {
getService().deleteEntry(entry);
}
public static void deleteEntry(long entryId)
throws com.liferay.portal.kernel.exception.PortalException {
getService().deleteEntry(entryId);
}
/**
* @throws PortalException
*/
public static com.liferay.portal.kernel.model.PersistedModel deletePersistedModel(
com.liferay.portal.kernel.model.PersistedModel persistedModel)
throws com.liferay.portal.kernel.exception.PortalException {
return getService().deletePersistedModel(persistedModel);
}
public static com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery() {
return getService().dynamicQuery();
}
/**
* Performs a dynamic query on the database and returns the matching rows.
*
* @param dynamicQuery the dynamic query
* @return the matching rows
*/
public static java.util.List dynamicQuery(
com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) {
return getService().dynamicQuery(dynamicQuery);
}
/**
* 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 {@link 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 and pagination is required (start and end are not {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link com.liferay.portlet.announcements.model.impl.AnnouncementsEntryModelImpl}. If both orderByComparator and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.
*
*
* @param dynamicQuery the dynamic query
* @param start the lower bound of the range of model instances
* @param end the upper bound of the range of model instances (not inclusive)
* @return the range of matching rows
*/
public static java.util.List dynamicQuery(
com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
int end) {
return getService().dynamicQuery(dynamicQuery, start, end);
}
/**
* 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 {@link 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 and pagination is required (start and end are not {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link com.liferay.portlet.announcements.model.impl.AnnouncementsEntryModelImpl}. If both orderByComparator and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.
*
*
* @param dynamicQuery the dynamic query
* @param start the lower bound of the range of model instances
* @param end the upper bound of the range of model instances (not inclusive)
* @param orderByComparator the comparator to order the results by (optionally null)
* @return the ordered range of matching rows
*/
public static java.util.List dynamicQuery(
com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start,
int end,
com.liferay.portal.kernel.util.OrderByComparator orderByComparator) {
return getService()
.dynamicQuery(dynamicQuery, start, end, orderByComparator);
}
/**
* Returns the number of rows matching the dynamic query.
*
* @param dynamicQuery the dynamic query
* @return the number of rows matching the dynamic query
*/
public static long dynamicQueryCount(
com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) {
return getService().dynamicQueryCount(dynamicQuery);
}
/**
* Returns the number of rows matching the dynamic query.
*
* @param dynamicQuery the dynamic query
* @param projection the projection to apply to the query
* @return the number of rows matching the dynamic query
*/
public static long dynamicQueryCount(
com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery,
com.liferay.portal.kernel.dao.orm.Projection projection) {
return getService().dynamicQueryCount(dynamicQuery, projection);
}
public static com.liferay.announcements.kernel.model.AnnouncementsEntry fetchAnnouncementsEntry(
long entryId) {
return getService().fetchAnnouncementsEntry(entryId);
}
/**
* Returns the announcements entry with the matching UUID and company.
*
* @param uuid the announcements entry's UUID
* @param companyId the primary key of the company
* @return the matching announcements entry, or null if a matching announcements entry could not be found
*/
public static com.liferay.announcements.kernel.model.AnnouncementsEntry fetchAnnouncementsEntryByUuidAndCompanyId(
java.lang.String uuid, long companyId) {
return getService()
.fetchAnnouncementsEntryByUuidAndCompanyId(uuid, companyId);
}
public static com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery() {
return getService().getActionableDynamicQuery();
}
/**
* 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 {@link 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 and pagination is required (start and end are not {@link com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS}), then the query will include the default ORDER BY logic from {@link com.liferay.portlet.announcements.model.impl.AnnouncementsEntryModelImpl}. If both orderByComparator and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.
*
*
* @param start the lower bound of the range of announcements entries
* @param end the upper bound of the range of announcements entries (not inclusive)
* @return the range of announcements entries
*/
public static java.util.List getAnnouncementsEntries(
int start, int end) {
return getService().getAnnouncementsEntries(start, end);
}
/**
* Returns the number of announcements entries.
*
* @return the number of announcements entries
*/
public static int getAnnouncementsEntriesCount() {
return getService().getAnnouncementsEntriesCount();
}
/**
* Returns the announcements entry with the primary key.
*
* @param entryId the primary key of the announcements entry
* @return the announcements entry
* @throws PortalException if a announcements entry with the primary key could not be found
*/
public static com.liferay.announcements.kernel.model.AnnouncementsEntry getAnnouncementsEntry(
long entryId)
throws com.liferay.portal.kernel.exception.PortalException {
return getService().getAnnouncementsEntry(entryId);
}
/**
* Returns the announcements entry with the matching UUID and company.
*
* @param uuid the announcements entry's UUID
* @param companyId the primary key of the company
* @return the matching announcements entry
* @throws PortalException if a matching announcements entry could not be found
*/
public static com.liferay.announcements.kernel.model.AnnouncementsEntry getAnnouncementsEntryByUuidAndCompanyId(
java.lang.String uuid, long companyId)
throws com.liferay.portal.kernel.exception.PortalException {
return getService()
.getAnnouncementsEntryByUuidAndCompanyId(uuid, companyId);
}
public static java.util.List getEntries(
long classNameId, long classPK, boolean alert, int start, int end) {
return getService().getEntries(classNameId, classPK, alert, start, end);
}
public static java.util.List 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) {
return getService()
.getEntries(userId, classNameId, classPKs, displayDateMonth,
displayDateDay, displayDateYear, displayDateHour,
displayDateMinute, expirationDateMonth, expirationDateDay,
expirationDateYear, expirationDateHour, expirationDateMinute,
alert, flagValue, start, end);
}
public static java.util.List getEntries(
long userId, java.util.LinkedHashMap scopes,
boolean alert, int flagValue, int start, int end) {
return getService()
.getEntries(userId, scopes, alert, flagValue, start, end);
}
public static java.util.List getEntries(
long userId, java.util.LinkedHashMap 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) {
return getService()
.getEntries(userId, scopes, displayDateMonth,
displayDateDay, displayDateYear, displayDateHour,
displayDateMinute, expirationDateMonth, expirationDateDay,
expirationDateYear, expirationDateHour, expirationDateMinute,
alert, flagValue, start, end);
}
public static int getEntriesCount(long classNameId, long classPK,
boolean alert) {
return getService().getEntriesCount(classNameId, classPK, alert);
}
public static int getEntriesCount(long userId, long classNameId,
long[] classPKs, boolean alert, int flagValue) {
return getService()
.getEntriesCount(userId, classNameId, classPKs, alert,
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) {
return getService()
.getEntriesCount(userId, classNameId, classPKs,
displayDateMonth, displayDateDay, displayDateYear, displayDateHour,
displayDateMinute, expirationDateMonth, expirationDateDay,
expirationDateYear, expirationDateHour, expirationDateMinute,
alert, flagValue);
}
public static int getEntriesCount(long userId,
java.util.LinkedHashMap scopes, boolean alert,
int flagValue) {
return getService().getEntriesCount(userId, scopes, alert, flagValue);
}
public static int getEntriesCount(long userId,
java.util.LinkedHashMap 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) {
return getService()
.getEntriesCount(userId, scopes, displayDateMonth,
displayDateDay, displayDateYear, displayDateHour,
displayDateMinute, expirationDateMonth, expirationDateDay,
expirationDateYear, expirationDateHour, expirationDateMinute,
alert, flagValue);
}
public static com.liferay.announcements.kernel.model.AnnouncementsEntry getEntry(
long entryId)
throws com.liferay.portal.kernel.exception.PortalException {
return getService().getEntry(entryId);
}
public static com.liferay.portal.kernel.dao.orm.ExportActionableDynamicQuery getExportActionableDynamicQuery(
com.liferay.exportimport.kernel.lar.PortletDataContext portletDataContext) {
return getService().getExportActionableDynamicQuery(portletDataContext);
}
public static com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery getIndexableActionableDynamicQuery() {
return getService().getIndexableActionableDynamicQuery();
}
/**
* Returns the OSGi service identifier.
*
* @return the OSGi service identifier
*/
public static java.lang.String getOSGiServiceIdentifier() {
return getService().getOSGiServiceIdentifier();
}
public static com.liferay.portal.kernel.model.PersistedModel getPersistedModel(
java.io.Serializable primaryKeyObj)
throws com.liferay.portal.kernel.exception.PortalException {
return getService().getPersistedModel(primaryKeyObj);
}
public static java.util.List getUserEntries(
long userId, int start, int end) {
return getService().getUserEntries(userId, start, end);
}
public static int getUserEntriesCount(long userId) {
return getService().getUserEntriesCount(userId);
}
/**
* Updates the announcements entry in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
*
* @param announcementsEntry the announcements entry
* @return the announcements entry that was updated
*/
public static com.liferay.announcements.kernel.model.AnnouncementsEntry updateAnnouncementsEntry(
com.liferay.announcements.kernel.model.AnnouncementsEntry announcementsEntry) {
return getService().updateAnnouncementsEntry(announcementsEntry);
}
public static com.liferay.announcements.kernel.model.AnnouncementsEntry updateEntry(
long userId, long entryId, java.lang.String title,
java.lang.String content, java.lang.String url, java.lang.String type,
int displayDateMonth, int displayDateDay, int displayDateYear,
int displayDateHour, int displayDateMinute, boolean displayImmediately,
int expirationDateMonth, int expirationDateDay, int expirationDateYear,
int expirationDateHour, int expirationDateMinute, int priority)
throws com.liferay.portal.kernel.exception.PortalException {
return getService()
.updateEntry(userId, entryId, title, content, url, type,
displayDateMonth, displayDateDay, displayDateYear, displayDateHour,
displayDateMinute, displayImmediately, expirationDateMonth,
expirationDateDay, expirationDateYear, expirationDateHour,
expirationDateMinute, priority);
}
public static AnnouncementsEntryLocalService getService() {
if (_service == null) {
_service = (AnnouncementsEntryLocalService)PortalBeanLocatorUtil.locate(AnnouncementsEntryLocalService.class.getName());
ReferenceRegistry.registerReference(AnnouncementsEntryLocalServiceUtil.class,
"_service");
}
return _service;
}
private static AnnouncementsEntryLocalService _service;
} © 2015 - 2025 Weber Informatics LLC | Privacy Policy