Liferay 6.1.2-ce-ga3

com.liferay.portlet.calendar.service
Interface CalEventLocalService

All Superinterfaces:
BaseLocalService, PersistedModelLocalService
All Known Implementing Classes:
CalEventLocalServiceBaseImpl, CalEventLocalServiceImpl, CalEventLocalServiceWrapper

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

The interface for the cal event local service.

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:
CalEventLocalServiceUtil, CalEventLocalServiceBaseImpl, CalEventLocalServiceImpl
ServiceBuilder generated this class. Modifications in this class will be overwritten the next time it is generated.

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. 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.
 void deleteEvent(CalEvent event)
           
 void 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.
 File exportEvent(long userId, long eventId)
           
 File exportGroupEvents(long userId, long groupId, String fileName)
           
 CalEvent fetchCalEvent(long eventId)
           
 String getBeanIdentifier()
          Returns the Spring bean ID for this bean.
 CalEvent getCalEvent(long eventId)
          Returns the cal event with the primary key.
 CalEvent getCalEventByUuidAndGroupId(String uuid, long groupId)
          Returns the cal event with the UUID in the 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 updateCalEvent(CalEvent calEvent, boolean merge)
          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. 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

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

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

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.

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.

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

fetchCalEvent

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

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

getCalEventByUuidAndGroupId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
CalEvent getCalEventByUuidAndGroupId(String uuid,
                                                                              long groupId)
                                     throws PortalException,
                                            SystemException
Returns the cal event with the UUID in the group.

Parameters:
uuid - the UUID of cal event
groupId - the group id of the cal event
Returns:
the cal event
Throws:
PortalException - if a cal event with the UUID in the group 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.

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

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

updateCalEvent

CalEvent updateCalEvent(CalEvent calEvent,
                        boolean merge)
                        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
merge - whether to merge the cal event 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 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

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

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. 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 PortalException,
                        SystemException
Throws:
PortalException
SystemException

deleteEvent

void deleteEvent(CalEvent event)
                 throws PortalException,
                        SystemException
Throws:
PortalException
SystemException

deleteEvent

void 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

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

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

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. 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

Liferay 6.1.2-ce-ga3