Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
Liferay 6.2-ce-ga5
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

com.liferay.portlet.announcements.service
Interface AnnouncementsEntryLocalService

All Superinterfaces:
BaseLocalService, PersistedModelLocalService
All Known Implementing Classes:
AnnouncementsEntryLocalServiceWrapper
@ProviderType
@Transactional(isolation=PORTAL,
               rollbackFor={PortalException.class,SystemException.class})
public interface AnnouncementsEntryLocalService
extends BaseLocalService, PersistedModelLocalService

Provides the local service interface for AnnouncementsEntry. 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:
AnnouncementsEntryLocalServiceUtil, com.liferay.portlet.announcements.service.base.AnnouncementsEntryLocalServiceBaseImpl, com.liferay.portlet.announcements.service.impl.AnnouncementsEntryLocalServiceImpl

Method Summary
 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, 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)
           
 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)
 void checkEntries()
           
 AnnouncementsEntry createAnnouncementsEntry(long entryId)
          Creates a new announcements entry with the primary key.
 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 deleteEntry(AnnouncementsEntry entry)
           
 void deleteEntry(long entryId)
           
 DynamicQuery dynamicQuery()
           
 List dynamicQuery(DynamicQuery dynamicQuery)
          Performs a dynamic query on the database and returns the matching rows.
 List dynamicQuery(DynamicQuery dynamicQuery, int start, int end)
          Performs a dynamic query on the database and returns a range of the matching rows.
 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.
 long dynamicQueryCount(DynamicQuery dynamicQuery)
          Returns the number of rows that match the dynamic query.
 long dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection)
          Returns the number of rows that match the dynamic query.
 AnnouncementsEntry fetchAnnouncementsEntry(long entryId)
           
 AnnouncementsEntry fetchAnnouncementsEntryByUuidAndCompanyId(String uuid, long companyId)
          Returns the announcements entry with the matching UUID and company.
 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.
 String getBeanIdentifier()
          Returns the Spring bean ID for this bean.
 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 classNameId, long classPK, boolean alert, 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)
           
 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 classNameId, long classPK, boolean alert)
           
 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)
           
 AnnouncementsEntry getEntry(long entryId)
           
 PersistedModel getPersistedModel(Serializable primaryKeyObj)
           
 List<AnnouncementsEntry> getUserEntries(long userId, int start, int end)
           
 int getUserEntriesCount(long userId)
           
 void setBeanIdentifier(String beanIdentifier)
          Sets the Spring bean ID for this bean.
 AnnouncementsEntry updateAnnouncementsEntry(AnnouncementsEntry announcementsEntry)
          Updates the announcements entry in the database or adds it if it does not yet exist.
 AnnouncementsEntry updateEntry(long userId, long entryId, String title, String content, String url, 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)
           
 

Method Detail

addAnnouncementsEntry

@Indexable(type=REINDEX)
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

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

@Indexable(type=DELETE)
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

@Indexable(type=DELETE)
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

DynamicQuery dynamicQuery()

dynamicQuery

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

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. 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 QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from 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.

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

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. 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 QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from 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.

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

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

dynamicQueryCount

long dynamicQueryCount(DynamicQuery dynamicQuery,
                       Projection projection)
                       throws SystemException
Returns the number of rows that match the dynamic query.

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

fetchAnnouncementsEntry

@Transactional(propagation=SUPPORTS,
               readOnly=true)
AnnouncementsEntry fetchAnnouncementsEntry(long entryId)
                                           throws SystemException
Throws:
SystemException

fetchAnnouncementsEntryByUuidAndCompanyId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
AnnouncementsEntry fetchAnnouncementsEntryByUuidAndCompanyId(String uuid,
                                                                                                      long companyId)
                                                             throws SystemException
Returns the announcements entry with the matching UUID and company.

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

getAnnouncementsEntry

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
PersistedModel getPersistedModel(Serializable primaryKeyObj)
                                 throws PortalException,
                                        SystemException
Specified by:
getPersistedModel in interface PersistedModelLocalService
Throws:
PortalException
SystemException

getAnnouncementsEntryByUuidAndCompanyId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
AnnouncementsEntry getAnnouncementsEntryByUuidAndCompanyId(String uuid,
                                                                                                    long companyId)
                                                           throws PortalException,
                                                                  SystemException
Returns the announcements entry with the matching UUID and company.

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

getAnnouncementsEntries

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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. 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 QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from 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.

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

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getAnnouncementsEntriesCount()
                                 throws SystemException
Returns the number of announcements entries.

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

updateAnnouncementsEntry

@Indexable(type=REINDEX)
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

getBeanIdentifier

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

Returns:
the Spring bean ID for this bean

setBeanIdentifier

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

Parameters:
beanIdentifier - the Spring bean ID for this bean

addEntry

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 displayImmediately,
                            int expirationDateMonth,
                            int expirationDateDay,
                            int expirationDateYear,
                            int expirationDateHour,
                            int expirationDateMinute,
                            int priority,
                            boolean alert)
                            throws PortalException,
                                   SystemException
Throws:
PortalException
SystemException

addEntry

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

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

deleteEntry

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

deleteEntry

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

getEntries

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<AnnouncementsEntry> getEntries(long userId,
                                                                             LinkedHashMap<Long,long[]> scopes,
                                                                             boolean alert,
                                                                             int flagValue,
                                                                             int start,
                                                                             int end)
                                    throws SystemException
Throws:
SystemException

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

getEntries

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<AnnouncementsEntry> getEntries(long classNameId,
                                                                             long classPK,
                                                                             boolean alert,
                                                                             int start,
                                                                             int end)
                                    throws SystemException
Throws:
SystemException

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

getEntriesCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getEntriesCount(long userId,
                                                             LinkedHashMap<Long,long[]> scopes,
                                                             boolean alert,
                                                             int flagValue)
                    throws SystemException
Throws:
SystemException

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

getEntriesCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getEntriesCount(long classNameId,
                                                             long classPK,
                                                             boolean alert)
                    throws SystemException
Throws:
SystemException

getEntriesCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getEntriesCount(long userId,
                                                             long classNameId,
                                                             long[] classPKs,
                                                             boolean alert,
                                                             int flagValue)
                    throws SystemException
Throws:
SystemException

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

getEntry

@Transactional(propagation=SUPPORTS,
               readOnly=true)
AnnouncementsEntry getEntry(long entryId)
                            throws PortalException,
                                   SystemException
Throws:
PortalException
SystemException

getUserEntries

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<AnnouncementsEntry> getUserEntries(long userId,
                                                                                 int start,
                                                                                 int end)
                                        throws SystemException
Throws:
SystemException

getUserEntriesCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getUserEntriesCount(long userId)
                        throws SystemException
Throws:
SystemException

updateEntry

AnnouncementsEntry updateEntry(long userId,
                               long entryId,
                               String title,
                               String content,
                               String url,
                               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 PortalException,
                                      SystemException
Throws:
PortalException
SystemException
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
Liferay 6.2-ce-ga5
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD