Liferay 6.1.2-ce-ga3

com.liferay.portlet.announcements.service
Class AnnouncementsEntryLocalServiceUtil

java.lang.Object
  extended by com.liferay.portlet.announcements.service.AnnouncementsEntryLocalServiceUtil

public class AnnouncementsEntryLocalServiceUtil
extends Object

The utility for the announcements entry local service. This utility wraps 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.

This is a local service. 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.

See Also:
AnnouncementsEntryLocalService, com.liferay.portlet.announcements.service.base.AnnouncementsEntryLocalServiceBaseImpl, com.liferay.portlet.announcements.service.impl.AnnouncementsEntryLocalServiceImpl

Constructor Summary
AnnouncementsEntryLocalServiceUtil()
           
 
Method Summary
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, int displayDateMonth, int displayDateDay, int displayDateYear, int displayDateHour, int displayDateMinute, boolean autoDisplayDate, int expirationDateMonth, int expirationDateDay, int expirationDateYear, int expirationDateHour, int expirationDateMinute, int priority, boolean alert)
           
static AnnouncementsEntry addEntry(long userId, long classNameId, long classPK, String title, String content, String url, String type, int displayDateMonth, int displayDateDay, int displayDateYear, int displayDateHour, int displayDateMinute, int expirationDateMonth, int expirationDateDay, int expirationDateYear, int expirationDateHour, int expirationDateMinute, int priority, boolean alert)
          Deprecated. As of 6.2.0, replaced by addEntry(long, long, long, String, String, String, String, int, int, int, int, int, boolean, int, int, int, int, int, int, boolean)
static void checkEntries()
           
static AnnouncementsEntry createAnnouncementsEntry(long entryId)
          Creates a new announcements entry with the primary key.
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 deleteEntry(AnnouncementsEntry entry)
           
static void deleteEntry(long entryId)
           
static DynamicQuery dynamicQuery()
           
static List dynamicQuery(DynamicQuery dynamicQuery)
          Performs a dynamic query on the database and returns the matching rows.
static List dynamicQuery(DynamicQuery dynamicQuery, int start, int end)
          Performs a dynamic query on the database and returns a range of the matching rows.
static List dynamicQuery(DynamicQuery dynamicQuery, int start, int end, OrderByComparator 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 that match the dynamic query.
static AnnouncementsEntry fetchAnnouncementsEntry(long entryId)
           
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 String getBeanIdentifier()
          Returns the Spring bean ID for this bean.
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 classNameId, long classPK, boolean alert, 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 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 classNameId, long classPK, boolean alert)
           
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 AnnouncementsEntry getEntry(long entryId)
           
static PersistedModel getPersistedModel(Serializable primaryKeyObj)
           
static AnnouncementsEntryLocalService getService()
           
static List<AnnouncementsEntry> getUserEntries(long userId, int start, int end)
           
static int getUserEntriesCount(long userId)
           
static void setBeanIdentifier(String beanIdentifier)
          Sets the Spring bean ID for this bean.
 void setService(AnnouncementsEntryLocalService service)
          Deprecated.  
static AnnouncementsEntry updateAnnouncementsEntry(AnnouncementsEntry announcementsEntry)
          Updates the announcements entry in the database or adds it if it does not yet exist.
static AnnouncementsEntry updateAnnouncementsEntry(AnnouncementsEntry announcementsEntry, boolean merge)
          Updates the announcements entry in the database or adds it if it does not yet exist.
static AnnouncementsEntry updateEntry(long userId, long entryId, String title, String content, String url, String type, int displayDateMonth, int displayDateDay, int displayDateYear, int displayDateHour, int displayDateMinute, int expirationDateMonth, int expirationDateDay, int expirationDateYear, int expirationDateHour, int expirationDateMinute, int priority)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

AnnouncementsEntryLocalServiceUtil

public AnnouncementsEntryLocalServiceUtil()
Method Detail

addAnnouncementsEntry

public static AnnouncementsEntry addAnnouncementsEntry(AnnouncementsEntry announcementsEntry)
                                                throws SystemException
Adds the announcements entry to the database. Also notifies the appropriate model listeners.

Parameters:
announcementsEntry - the announcements entry
Returns:
the announcements entry that was added
Throws:
SystemException - if a system exception occurred

createAnnouncementsEntry

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

deleteAnnouncementsEntry

public static AnnouncementsEntry deleteAnnouncementsEntry(long entryId)
                                                   throws PortalException,
                                                          SystemException
Deletes the announcements entry with the primary key from the database. Also notifies the appropriate model listeners.

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
SystemException - if a system exception occurred

deleteAnnouncementsEntry

public static AnnouncementsEntry deleteAnnouncementsEntry(AnnouncementsEntry announcementsEntry)
                                                   throws SystemException
Deletes the announcements entry from the database. Also notifies the appropriate model listeners.

Parameters:
announcementsEntry - the announcements entry
Returns:
the announcements entry that was removed
Throws:
SystemException - if a system exception occurred

dynamicQuery

public static DynamicQuery dynamicQuery()

dynamicQuery

public static List dynamicQuery(DynamicQuery dynamicQuery)
                         throws SystemException
Performs a dynamic query on the database and returns the matching rows.

Parameters:
dynamicQuery - the dynamic query
Returns:
the matching rows
Throws:
SystemException - if a system exception occurred

dynamicQuery

public static List dynamicQuery(DynamicQuery dynamicQuery,
                                int start,
                                int end)
                         throws SystemException
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 QueryUtil.ALL_POS will return the full result set.

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
Throws:
SystemException - if a system exception occurred

dynamicQuery

public static List dynamicQuery(DynamicQuery dynamicQuery,
                                int start,
                                int end,
                                OrderByComparator orderByComparator)
                         throws SystemException
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 QueryUtil.ALL_POS will return the full result set.

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
Throws:
SystemException - if a system exception occurred

dynamicQueryCount

public static long dynamicQueryCount(DynamicQuery dynamicQuery)
                              throws SystemException
Returns the number of rows that match the dynamic query.

Parameters:
dynamicQuery - the dynamic query
Returns:
the number of rows that match the dynamic query
Throws:
SystemException - if a system exception occurred

fetchAnnouncementsEntry

public static AnnouncementsEntry fetchAnnouncementsEntry(long entryId)
                                                  throws SystemException
Throws:
SystemException

getAnnouncementsEntry

public static AnnouncementsEntry getAnnouncementsEntry(long entryId)
                                                throws PortalException,
                                                       SystemException
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
SystemException - if a system exception occurred

getPersistedModel

public static PersistedModel getPersistedModel(Serializable primaryKeyObj)
                                        throws PortalException,
                                               SystemException
Throws:
PortalException
SystemException

getAnnouncementsEntries

public static List<AnnouncementsEntry> getAnnouncementsEntries(int start,
                                                               int end)
                                                        throws SystemException
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 QueryUtil.ALL_POS will return the full result set.

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
Throws:
SystemException - if a system exception occurred

getAnnouncementsEntriesCount

public static int getAnnouncementsEntriesCount()
                                        throws SystemException
Returns the number of announcements entries.

Returns:
the number of announcements entries
Throws:
SystemException - if a system exception occurred

updateAnnouncementsEntry

public static AnnouncementsEntry updateAnnouncementsEntry(AnnouncementsEntry announcementsEntry)
                                                   throws SystemException
Updates the announcements entry in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

Parameters:
announcementsEntry - the announcements entry
Returns:
the announcements entry that was updated
Throws:
SystemException - if a system exception occurred

updateAnnouncementsEntry

public static AnnouncementsEntry updateAnnouncementsEntry(AnnouncementsEntry announcementsEntry,
                                                          boolean merge)
                                                   throws SystemException
Updates the announcements entry in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

Parameters:
announcementsEntry - the announcements entry
merge - whether to merge the announcements entry with the current session. See BatchSession.update(com.liferay.portal.kernel.dao.orm.Session, com.liferay.portal.model.BaseModel, boolean) for an explanation.
Returns:
the announcements entry that was updated
Throws:
SystemException - if a system exception occurred

getBeanIdentifier

public static String getBeanIdentifier()
Returns the Spring bean ID for this bean.

Returns:
the Spring bean ID for this bean

setBeanIdentifier

public static void setBeanIdentifier(String beanIdentifier)
Sets the Spring bean ID for this bean.

Parameters:
beanIdentifier - the Spring bean ID for this bean

addEntry

public static AnnouncementsEntry addEntry(long userId,
                                          long classNameId,
                                          long classPK,
                                          String title,
                                          String content,
                                          String url,
                                          String type,
                                          int displayDateMonth,
                                          int displayDateDay,
                                          int displayDateYear,
                                          int displayDateHour,
                                          int displayDateMinute,
                                          boolean autoDisplayDate,
                                          int expirationDateMonth,
                                          int expirationDateDay,
                                          int expirationDateYear,
                                          int expirationDateHour,
                                          int expirationDateMinute,
                                          int priority,
                                          boolean alert)
                                   throws PortalException,
                                          SystemException
Throws:
PortalException
SystemException

addEntry

public static AnnouncementsEntry addEntry(long userId,
                                          long classNameId,
                                          long classPK,
                                          String title,
                                          String content,
                                          String url,
                                          String type,
                                          int displayDateMonth,
                                          int displayDateDay,
                                          int displayDateYear,
                                          int displayDateHour,
                                          int displayDateMinute,
                                          int expirationDateMonth,
                                          int expirationDateDay,
                                          int expirationDateYear,
                                          int expirationDateHour,
                                          int expirationDateMinute,
                                          int priority,
                                          boolean alert)
                                   throws PortalException,
                                          SystemException
Deprecated. As of 6.2.0, replaced by addEntry(long, long, long, String, String, String, String, int, int, int, int, int, boolean, int, int, int, int, int, int, boolean)

Throws:
PortalException
SystemException

checkEntries

public static void checkEntries()
                         throws PortalException,
                                SystemException
Throws:
PortalException
SystemException

deleteEntry

public static void deleteEntry(AnnouncementsEntry entry)
                        throws PortalException,
                               SystemException
Throws:
PortalException
SystemException

deleteEntry

public static void deleteEntry(long entryId)
                        throws PortalException,
                               SystemException
Throws:
PortalException
SystemException

getEntries

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

getEntries

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)
                                           throws SystemException
Throws:
SystemException

getEntries

public static List<AnnouncementsEntry> getEntries(long classNameId,
                                                  long classPK,
                                                  boolean alert,
                                                  int start,
                                                  int end)
                                           throws SystemException
Throws:
SystemException

getEntries

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)
                                           throws SystemException
Throws:
SystemException

getEntriesCount

public static int getEntriesCount(long userId,
                                  LinkedHashMap<Long,long[]> scopes,
                                  boolean alert,
                                  int flagValue)
                           throws SystemException
Throws:
SystemException

getEntriesCount

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)
                           throws SystemException
Throws:
SystemException

getEntriesCount

public static int getEntriesCount(long classNameId,
                                  long classPK,
                                  boolean alert)
                           throws SystemException
Throws:
SystemException

getEntriesCount

public static int getEntriesCount(long userId,
                                  long classNameId,
                                  long[] classPKs,
                                  boolean alert,
                                  int flagValue)
                           throws SystemException
Throws:
SystemException

getEntriesCount

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)
                           throws SystemException
Throws:
SystemException

getEntry

public static AnnouncementsEntry getEntry(long entryId)
                                   throws PortalException,
                                          SystemException
Throws:
PortalException
SystemException

getUserEntries

public static List<AnnouncementsEntry> getUserEntries(long userId,
                                                      int start,
                                                      int end)
                                               throws SystemException
Throws:
SystemException

getUserEntriesCount

public static int getUserEntriesCount(long userId)
                               throws SystemException
Throws:
SystemException

updateEntry

public static AnnouncementsEntry updateEntry(long userId,
                                             long entryId,
                                             String title,
                                             String content,
                                             String url,
                                             String type,
                                             int displayDateMonth,
                                             int displayDateDay,
                                             int displayDateYear,
                                             int displayDateHour,
                                             int displayDateMinute,
                                             int expirationDateMonth,
                                             int expirationDateDay,
                                             int expirationDateYear,
                                             int expirationDateHour,
                                             int expirationDateMinute,
                                             int priority)
                                      throws PortalException,
                                             SystemException
Throws:
PortalException
SystemException

getService

public static AnnouncementsEntryLocalService getService()

setService

public void setService(AnnouncementsEntryLocalService service)
Deprecated. 


Liferay 6.1.2-ce-ga3