com.liferay.portlet.calendar.service
Interface CalEventLocalService

All Superinterfaces:

BaseLocalService, PersistedModelLocalService

All Known Implementing Classes:

CalEventLocalServiceWrapper

@ProviderType
@Transactional(isolation=PORTAL,
               rollbackFor={PortalException.class,SystemException.class})
public interface CalEventLocalService
extends BaseLocalService, PersistedModelLocalService

Provides the local service interface for CalEvent. 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:

CalEventLocalServiceUtil, com.liferay.portlet.calendar.service.base.CalEventLocalServiceBaseImpl, com.liferay.portlet.calendar.service.impl.CalEventLocalServiceImpl

Method Summary

CalEvent	addCalEvent(CalEvent calEvent) Adds the cal event to the database.
CalEvent	addEvent(long userId, String title, String description, String location, int startDateMonth, int startDateDay, int startDateYear, int startDateHour, int startDateMinute, int durationHour, int durationMinute, boolean allDay, boolean timeZoneSensitive, String type, boolean repeating, TZSRecurrence recurrence, int remindBy, int firstReminder, int secondReminder, ServiceContext serviceContext)
CalEvent	addEvent(long userId, String title, String description, String location, int startDateMonth, int startDateDay, int startDateYear, int startDateHour, int startDateMinute, int endDateMonth, int endDateDay, int endDateYear, int durationHour, int durationMinute, boolean allDay, boolean timeZoneSensitive, String type, boolean repeating, TZSRecurrence recurrence, int remindBy, int firstReminder, int secondReminder, ServiceContext serviceContext) Deprecated. As of 6.2.0, replaced by addEvent(long, String, String, String, int, int, int, int, int, int, int, boolean, boolean, String, boolean, TZSRecurrence, int, int, int, ServiceContext)
void	addEventResources(CalEvent event, boolean addGroupPermissions, boolean addGuestPermissions)
void	addEventResources(CalEvent event, String[] groupPermissions, String[] guestPermissions)
void	addEventResources(long eventId, boolean addGroupPermissions, boolean addGuestPermissions)
void	addEventResources(long eventId, String[] groupPermissions, String[] guestPermissions)
void	checkEvents()
CalEvent	createCalEvent(long eventId) Creates a new cal event with the primary key.
CalEvent	deleteCalEvent(CalEvent calEvent) Deletes the cal event from the database.
CalEvent	deleteCalEvent(long eventId) Deletes the cal event with the primary key from the database.
CalEvent	deleteEvent(CalEvent event)
CalEvent	deleteEvent(long eventId)
void	deleteEvents(long groupId)
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.
File	exportEvent(long userId, long eventId)
File	exportEvents(long userId, List<CalEvent> events, String fileName)
File	exportGroupEvents(long userId, long groupId, String fileName)
CalEvent	fetchCalEvent(long eventId)
CalEvent	fetchCalEventByUuidAndCompanyId(String uuid, long companyId) Returns the cal event with the matching UUID and company.
CalEvent	fetchCalEventByUuidAndGroupId(String uuid, long groupId) Returns the cal event matching the UUID and group.
String	getBeanIdentifier() Returns the Spring bean ID for this bean.
CalEvent	getCalEvent(long eventId) Returns the cal event with the primary key.
CalEvent	getCalEventByUuidAndCompanyId(String uuid, long companyId) Returns the cal event with the matching UUID and company.
CalEvent	getCalEventByUuidAndGroupId(String uuid, long groupId) Returns the cal event matching the UUID and group.
List<CalEvent>	getCalEvents(int start, int end) Returns a range of all the cal events.
int	getCalEventsCount() Returns the number of cal events.
List<CalEvent>	getCompanyEvents(long companyId, int start, int end)
int	getCompanyEventsCount(long companyId)
CalEvent	getEvent(long eventId)
List<CalEvent>	getEvents(long groupId, Calendar cal)
List<CalEvent>	getEvents(long groupId, Calendar cal, String type)
List<CalEvent>	getEvents(long groupId, Calendar cal, String[] types)
List<CalEvent>	getEvents(long groupId, String[] types, int start, int end)
List<CalEvent>	getEvents(long groupId, String type, int start, int end)
int	getEventsCount(long groupId, String type)
int	getEventsCount(long groupId, String[] types)
List<CalEvent>	getNoAssetEvents()
PersistedModel	getPersistedModel(Serializable primaryKeyObj)
List<CalEvent>	getRepeatingEvents(long groupId)
List<CalEvent>	getRepeatingEvents(long groupId, Calendar cal, String[] types)
boolean	hasEvents(long groupId, Calendar cal)
boolean	hasEvents(long groupId, Calendar cal, String type)
boolean	hasEvents(long groupId, Calendar cal, String[] types)
void	importICal4j(long userId, long groupId, InputStream inputStream)
void	setBeanIdentifier(String beanIdentifier) Sets the Spring bean ID for this bean.
void	updateAsset(long userId, CalEvent event, long[] assetCategoryIds, String[] assetTagNames, long[] assetLinkEntryIds)
CalEvent	updateCalEvent(CalEvent calEvent) Updates the cal event in the database or adds it if it does not yet exist.
CalEvent	updateEvent(long userId, long eventId, String title, String description, String location, int startDateMonth, int startDateDay, int startDateYear, int startDateHour, int startDateMinute, int durationHour, int durationMinute, boolean allDay, boolean timeZoneSensitive, String type, boolean repeating, TZSRecurrence recurrence, int remindBy, int firstReminder, int secondReminder, ServiceContext serviceContext)
CalEvent	updateEvent(long userId, long eventId, String title, String description, String location, int startDateMonth, int startDateDay, int startDateYear, int startDateHour, int startDateMinute, int endDateMonth, int endDateDay, int endDateYear, int durationHour, int durationMinute, boolean allDay, boolean timeZoneSensitive, String type, boolean repeating, TZSRecurrence recurrence, int remindBy, int firstReminder, int secondReminder, ServiceContext serviceContext) Deprecated. As of 6.2.0, replaced by updateEvent(long, long, String, String, String, int, int, int, int, int, int, int, boolean, boolean, String, boolean, TZSRecurrence, int, int, int, ServiceContext)

Method Detail

addCalEvent

@Indexable(type=REINDEX)
CalEvent addCalEvent(CalEvent calEvent)
                     throws SystemException

Adds the cal event to the database. Also notifies the appropriate model listeners.

Parameters:

calEvent - the cal event

Returns:

the cal event that was added

Throws:

SystemException - if a system exception occurred

createCalEvent

CalEvent createCalEvent(long eventId)

Creates a new cal event with the primary key. Does not add the cal event to the database.

Parameters:

eventId - the primary key for the new cal event

Returns:

the new cal event

deleteCalEvent

@Indexable(type=DELETE)
CalEvent deleteCalEvent(long eventId)
                        throws PortalException,
                               SystemException

Deletes the cal event with the primary key from the database. Also notifies the appropriate model listeners.

Parameters:

eventId - the primary key of the cal event

Returns:

the cal event that was removed

Throws:

PortalException - if a cal event with the primary key could not be found

SystemException - if a system exception occurred

deleteCalEvent

@Indexable(type=DELETE)
CalEvent deleteCalEvent(CalEvent calEvent)
                        throws SystemException

Deletes the cal event from the database. Also notifies the appropriate model listeners.

Parameters:

calEvent - the cal event

Returns:

the cal event 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 CalEventModelImpl. 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 CalEventModelImpl. 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

fetchCalEvent

@Transactional(propagation=SUPPORTS,
               readOnly=true)
CalEvent fetchCalEvent(long eventId)
                       throws SystemException

Throws:

SystemException

fetchCalEventByUuidAndCompanyId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
CalEvent fetchCalEventByUuidAndCompanyId(String uuid,
                                                                                  long companyId)
                                         throws SystemException

Returns the cal event with the matching UUID and company.

Parameters:

uuid - the cal event's UUID

companyId - the primary key of the company

Returns:

the matching cal event, or null if a matching cal event could not be found

Throws:

SystemException - if a system exception occurred

fetchCalEventByUuidAndGroupId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
CalEvent fetchCalEventByUuidAndGroupId(String uuid,
                                                                                long groupId)
                                       throws SystemException

Returns the cal event matching the UUID and group.

Parameters:

uuid - the cal event's UUID

groupId - the primary key of the group

Returns:

the matching cal event, or null if a matching cal event could not be found

Throws:

SystemException - if a system exception occurred

getCalEvent

@Transactional(propagation=SUPPORTS,
               readOnly=true)
CalEvent getCalEvent(long eventId)
                     throws PortalException,
                            SystemException

Returns the cal event with the primary key.

Parameters:

eventId - the primary key of the cal event

Returns:

the cal event

Throws:

PortalException - if a cal event 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

getCalEventByUuidAndCompanyId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
CalEvent getCalEventByUuidAndCompanyId(String uuid,
                                                                                long companyId)
                                       throws PortalException,
                                              SystemException

Returns the cal event with the matching UUID and company.

Parameters:

uuid - the cal event's UUID

companyId - the primary key of the company

Returns:

the matching cal event

Throws:

PortalException - if a matching cal event could not be found

SystemException - if a system exception occurred

getCalEventByUuidAndGroupId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
CalEvent getCalEventByUuidAndGroupId(String uuid,
                                                                              long groupId)
                                     throws PortalException,
                                            SystemException

Returns the cal event matching the UUID and group.

Parameters:

uuid - the cal event's UUID

groupId - the primary key of the group

Returns:

the matching cal event

Throws:

PortalException - if a matching cal event could not be found

SystemException - if a system exception occurred

getCalEvents

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<CalEvent> getCalEvents(int start,
                                                                     int end)
                            throws SystemException

Returns a range of all the cal events.

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 CalEventModelImpl. 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 cal events

end - the upper bound of the range of cal events (not inclusive)

Returns:

the range of cal events

Throws:

SystemException - if a system exception occurred

getCalEventsCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getCalEventsCount()
                      throws SystemException

Returns the number of cal events.

Returns:

the number of cal events

Throws:

SystemException - if a system exception occurred

updateCalEvent

@Indexable(type=REINDEX)
CalEvent updateCalEvent(CalEvent calEvent)
                        throws SystemException

Updates the cal event in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

Parameters:

calEvent - the cal event

Returns:

the cal event 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

addEvent

@Indexable(type=REINDEX)
CalEvent addEvent(long userId,
                                       String title,
                                       String description,
                                       String location,
                                       int startDateMonth,
                                       int startDateDay,
                                       int startDateYear,
                                       int startDateHour,
                                       int startDateMinute,
                                       int durationHour,
                                       int durationMinute,
                                       boolean allDay,
                                       boolean timeZoneSensitive,
                                       String type,
                                       boolean repeating,
                                       TZSRecurrence recurrence,
                                       int remindBy,
                                       int firstReminder,
                                       int secondReminder,
                                       ServiceContext serviceContext)
                  throws PortalException,
                         SystemException

Throws:

PortalException

SystemException

addEvent

@Indexable(type=REINDEX)
CalEvent addEvent(long userId,
                                       String title,
                                       String description,
                                       String location,
                                       int startDateMonth,
                                       int startDateDay,
                                       int startDateYear,
                                       int startDateHour,
                                       int startDateMinute,
                                       int endDateMonth,
                                       int endDateDay,
                                       int endDateYear,
                                       int durationHour,
                                       int durationMinute,
                                       boolean allDay,
                                       boolean timeZoneSensitive,
                                       String type,
                                       boolean repeating,
                                       TZSRecurrence recurrence,
                                       int remindBy,
                                       int firstReminder,
                                       int secondReminder,
                                       ServiceContext serviceContext)
                  throws PortalException,
                         SystemException

Deprecated. As of 6.2.0, replaced by addEvent(long, String, String, String, int, int, int, int, int, int, int, boolean, boolean, String, boolean, TZSRecurrence, int, int, int, ServiceContext)

Throws:

PortalException

SystemException

addEventResources

void addEventResources(CalEvent event,
                       boolean addGroupPermissions,
                       boolean addGuestPermissions)
                       throws PortalException,
                              SystemException

Throws:

PortalException

SystemException

addEventResources

void addEventResources(CalEvent event,
                       String[] groupPermissions,
                       String[] guestPermissions)
                       throws PortalException,
                              SystemException

Throws:

PortalException

SystemException

addEventResources

void addEventResources(long eventId,
                       boolean addGroupPermissions,
                       boolean addGuestPermissions)
                       throws PortalException,
                              SystemException

Throws:

PortalException

SystemException

addEventResources

void addEventResources(long eventId,
                       String[] groupPermissions,
                       String[] guestPermissions)
                       throws PortalException,
                              SystemException

Throws:

PortalException

SystemException

checkEvents

void checkEvents()
                 throws SystemException

Throws:

SystemException

deleteEvent

@Indexable(type=DELETE)
CalEvent deleteEvent(CalEvent event)
                     throws PortalException,
                            SystemException

Throws:

PortalException

SystemException

deleteEvent

@Indexable(type=DELETE)
CalEvent deleteEvent(long eventId)
                     throws PortalException,
                            SystemException

Throws:

PortalException

SystemException

deleteEvents

void deleteEvents(long groupId)
                  throws PortalException,
                         SystemException

Throws:

PortalException

SystemException

exportEvent

File exportEvent(long userId,
                 long eventId)
                 throws PortalException,
                        SystemException

Throws:

PortalException

SystemException

exportEvents

File exportEvents(long userId,
                  List<CalEvent> events,
                  String fileName)
                  throws PortalException,
                         SystemException

Throws:

PortalException

SystemException

exportGroupEvents

File exportGroupEvents(long userId,
                       long groupId,
                       String fileName)
                       throws PortalException,
                              SystemException

Throws:

PortalException

SystemException

getCompanyEvents

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<CalEvent> getCompanyEvents(long companyId,
                                                                         int start,
                                                                         int end)
                                throws SystemException

Throws:

SystemException

getCompanyEventsCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getCompanyEventsCount(long companyId)
                          throws SystemException

Throws:

SystemException

getEvent

@Transactional(propagation=SUPPORTS,
               readOnly=true)
CalEvent getEvent(long eventId)
                  throws PortalException,
                         SystemException

Throws:

PortalException

SystemException

getEvents

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<CalEvent> getEvents(long groupId,
                                                                  Calendar cal)
                         throws SystemException

Throws:

SystemException

getEvents

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<CalEvent> getEvents(long groupId,
                                                                  Calendar cal,
                                                                  String type)
                         throws SystemException

Throws:

SystemException

getEvents

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<CalEvent> getEvents(long groupId,
                                                                  Calendar cal,
                                                                  String[] types)
                         throws SystemException

Throws:

SystemException

getEvents

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<CalEvent> getEvents(long groupId,
                                                                  String type,
                                                                  int start,
                                                                  int end)
                         throws SystemException

Throws:

SystemException

getEvents

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<CalEvent> getEvents(long groupId,
                                                                  String[] types,
                                                                  int start,
                                                                  int end)
                         throws SystemException

Throws:

SystemException

getEventsCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getEventsCount(long groupId,
                                                            String type)
                   throws SystemException

Throws:

SystemException

getEventsCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getEventsCount(long groupId,
                                                            String[] types)
                   throws SystemException

Throws:

SystemException

getNoAssetEvents

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<CalEvent> getNoAssetEvents()
                                throws SystemException

Throws:

SystemException

getRepeatingEvents

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<CalEvent> getRepeatingEvents(long groupId)
                                  throws SystemException

Throws:

SystemException

getRepeatingEvents

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<CalEvent> getRepeatingEvents(long groupId,
                                                                           Calendar cal,
                                                                           String[] types)
                                  throws SystemException

Throws:

SystemException

hasEvents

@Transactional(propagation=SUPPORTS,
               readOnly=true)
boolean hasEvents(long groupId,
                                                           Calendar cal)
                  throws SystemException

Throws:

SystemException

hasEvents

@Transactional(propagation=SUPPORTS,
               readOnly=true)
boolean hasEvents(long groupId,
                                                           Calendar cal,
                                                           String type)
                  throws SystemException

Throws:

SystemException

hasEvents

@Transactional(propagation=SUPPORTS,
               readOnly=true)
boolean hasEvents(long groupId,
                                                           Calendar cal,
                                                           String[] types)
                  throws SystemException

Throws:

SystemException

importICal4j

void importICal4j(long userId,
                  long groupId,
                  InputStream inputStream)
                  throws PortalException,
                         SystemException

Throws:

PortalException

SystemException

updateAsset

void updateAsset(long userId,
                 CalEvent event,
                 long[] assetCategoryIds,
                 String[] assetTagNames,
                 long[] assetLinkEntryIds)
                 throws PortalException,
                        SystemException

Throws:

PortalException

SystemException

updateEvent

@Indexable(type=REINDEX)
CalEvent updateEvent(long userId,
                                          long eventId,
                                          String title,
                                          String description,
                                          String location,
                                          int startDateMonth,
                                          int startDateDay,
                                          int startDateYear,
                                          int startDateHour,
                                          int startDateMinute,
                                          int durationHour,
                                          int durationMinute,
                                          boolean allDay,
                                          boolean timeZoneSensitive,
                                          String type,
                                          boolean repeating,
                                          TZSRecurrence recurrence,
                                          int remindBy,
                                          int firstReminder,
                                          int secondReminder,
                                          ServiceContext serviceContext)
                     throws PortalException,
                            SystemException

Throws:

PortalException

SystemException

updateEvent

@Indexable(type=REINDEX)
CalEvent updateEvent(long userId,
                                          long eventId,
                                          String title,
                                          String description,
                                          String location,
                                          int startDateMonth,
                                          int startDateDay,
                                          int startDateYear,
                                          int startDateHour,
                                          int startDateMinute,
                                          int endDateMonth,
                                          int endDateDay,
                                          int endDateYear,
                                          int durationHour,
                                          int durationMinute,
                                          boolean allDay,
                                          boolean timeZoneSensitive,
                                          String type,
                                          boolean repeating,
                                          TZSRecurrence recurrence,
                                          int remindBy,
                                          int firstReminder,
                                          int secondReminder,
                                          ServiceContext serviceContext)
                     throws PortalException,
                            SystemException

Deprecated. As of 6.2.0, replaced by updateEvent(long, long, String, String, String, int, int, int, int, int, int, int, boolean, boolean, String, boolean, TZSRecurrence, int, int, int, ServiceContext)

Throws:

PortalException

SystemException