Liferay 6.2-ce-ga5

com.liferay.portlet.calendar.service
Class CalEventLocalServiceUtil

java.lang.Object
  extended by com.liferay.portlet.calendar.service.CalEventLocalServiceUtil

@ProviderType
public class CalEventLocalServiceUtil
extends Object

Provides the local service utility for CalEvent. This utility wraps com.liferay.portlet.calendar.service.impl.CalEventLocalServiceImpl and is the primary access point for service operations in application layer code running on the local server. Methods of this service will not have security checks based on the propagated JAAS credentials because this service can only be accessed from within the same VM.

See Also:
CalEventLocalService, com.liferay.portlet.calendar.service.base.CalEventLocalServiceBaseImpl, com.liferay.portlet.calendar.service.impl.CalEventLocalServiceImpl

Constructor Summary
CalEventLocalServiceUtil()
           
 
Method Summary
static CalEvent addCalEvent(CalEvent calEvent)
          Adds the cal event to the database.
static 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)
           
static 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)
static void addEventResources(CalEvent event, boolean addGroupPermissions, boolean addGuestPermissions)
           
static void addEventResources(CalEvent event, String[] groupPermissions, String[] guestPermissions)
           
static void addEventResources(long eventId, boolean addGroupPermissions, boolean addGuestPermissions)
           
static void addEventResources(long eventId, String[] groupPermissions, String[] guestPermissions)
           
static void checkEvents()
           
static CalEvent createCalEvent(long eventId)
          Creates a new cal event with the primary key.
static CalEvent deleteCalEvent(CalEvent calEvent)
          Deletes the cal event from the database.
static CalEvent deleteCalEvent(long eventId)
          Deletes the cal event with the primary key from the database.
static CalEvent deleteEvent(CalEvent event)
           
static CalEvent deleteEvent(long eventId)
           
static void deleteEvents(long groupId)
           
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 long dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection)
          Returns the number of rows that match the dynamic query.
static File exportEvent(long userId, long eventId)
           
static File exportEvents(long userId, List<CalEvent> events, String fileName)
           
static File exportGroupEvents(long userId, long groupId, String fileName)
           
static CalEvent fetchCalEvent(long eventId)
           
static CalEvent fetchCalEventByUuidAndCompanyId(String uuid, long companyId)
          Returns the cal event with the matching UUID and company.
static CalEvent fetchCalEventByUuidAndGroupId(String uuid, long groupId)
          Returns the cal event matching the UUID and group.
static String getBeanIdentifier()
          Returns the Spring bean ID for this bean.
static CalEvent getCalEvent(long eventId)
          Returns the cal event with the primary key.
static CalEvent getCalEventByUuidAndCompanyId(String uuid, long companyId)
          Returns the cal event with the matching UUID and company.
static CalEvent getCalEventByUuidAndGroupId(String uuid, long groupId)
          Returns the cal event matching the UUID and group.
static List<CalEvent> getCalEvents(int start, int end)
          Returns a range of all the cal events.
static int getCalEventsCount()
          Returns the number of cal events.
static List<CalEvent> getCompanyEvents(long companyId, int start, int end)
           
static int getCompanyEventsCount(long companyId)
           
static CalEvent getEvent(long eventId)
           
static List<CalEvent> getEvents(long groupId, Calendar cal)
           
static List<CalEvent> getEvents(long groupId, Calendar cal, String type)
           
static List<CalEvent> getEvents(long groupId, Calendar cal, String[] types)
           
static List<CalEvent> getEvents(long groupId, String[] types, int start, int end)
           
static List<CalEvent> getEvents(long groupId, String type, int start, int end)
           
static int getEventsCount(long groupId, String type)
           
static int getEventsCount(long groupId, String[] types)
           
static List<CalEvent> getNoAssetEvents()
           
static PersistedModel getPersistedModel(Serializable primaryKeyObj)
           
static List<CalEvent> getRepeatingEvents(long groupId)
           
static List<CalEvent> getRepeatingEvents(long groupId, Calendar cal, String[] types)
           
static CalEventLocalService getService()
           
static boolean hasEvents(long groupId, Calendar cal)
           
static boolean hasEvents(long groupId, Calendar cal, String type)
           
static boolean hasEvents(long groupId, Calendar cal, String[] types)
           
static void importICal4j(long userId, long groupId, InputStream inputStream)
           
static void setBeanIdentifier(String beanIdentifier)
          Sets the Spring bean ID for this bean.
 void setService(CalEventLocalService service)
          Deprecated. As of 6.2.0
static void updateAsset(long userId, CalEvent event, long[] assetCategoryIds, String[] assetTagNames, long[] assetLinkEntryIds)
           
static CalEvent updateCalEvent(CalEvent calEvent)
          Updates the cal event in the database or adds it if it does not yet exist.
static 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)
           
static 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)
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

CalEventLocalServiceUtil

public CalEventLocalServiceUtil()
Method Detail

addCalEvent

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

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

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

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

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

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

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

dynamicQueryCount

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

public static CalEvent fetchCalEvent(long eventId)
                              throws SystemException
Throws:
SystemException

fetchCalEventByUuidAndCompanyId

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

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

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

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

getCalEventByUuidAndCompanyId

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

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

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

public static int getCalEventsCount()
                             throws SystemException
Returns the number of cal events.

Returns:
the number of cal events
Throws:
SystemException - if a system exception occurred

updateCalEvent

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

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

addEvent

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

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

public static void addEventResources(CalEvent event,
                                     boolean addGroupPermissions,
                                     boolean addGuestPermissions)
                              throws PortalException,
                                     SystemException
Throws:
PortalException
SystemException

addEventResources

public static void addEventResources(CalEvent event,
                                     String[] groupPermissions,
                                     String[] guestPermissions)
                              throws PortalException,
                                     SystemException
Throws:
PortalException
SystemException

addEventResources

public static void addEventResources(long eventId,
                                     boolean addGroupPermissions,
                                     boolean addGuestPermissions)
                              throws PortalException,
                                     SystemException
Throws:
PortalException
SystemException

addEventResources

public static void addEventResources(long eventId,
                                     String[] groupPermissions,
                                     String[] guestPermissions)
                              throws PortalException,
                                     SystemException
Throws:
PortalException
SystemException

checkEvents

public static void checkEvents()
                        throws SystemException
Throws:
SystemException

deleteEvent

public static CalEvent deleteEvent(CalEvent event)
                            throws PortalException,
                                   SystemException
Throws:
PortalException
SystemException

deleteEvent

public static CalEvent deleteEvent(long eventId)
                            throws PortalException,
                                   SystemException
Throws:
PortalException
SystemException

deleteEvents

public static void deleteEvents(long groupId)
                         throws PortalException,
                                SystemException
Throws:
PortalException
SystemException

exportEvent

public static File exportEvent(long userId,
                               long eventId)
                        throws PortalException,
                               SystemException
Throws:
PortalException
SystemException

exportEvents

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

exportGroupEvents

public static File exportGroupEvents(long userId,
                                     long groupId,
                                     String fileName)
                              throws PortalException,
                                     SystemException
Throws:
PortalException
SystemException

getCompanyEvents

public static List<CalEvent> getCompanyEvents(long companyId,
                                              int start,
                                              int end)
                                       throws SystemException
Throws:
SystemException

getCompanyEventsCount

public static int getCompanyEventsCount(long companyId)
                                 throws SystemException
Throws:
SystemException

getEvent

public static CalEvent getEvent(long eventId)
                         throws PortalException,
                                SystemException
Throws:
PortalException
SystemException

getEvents

public static List<CalEvent> getEvents(long groupId,
                                       Calendar cal)
                                throws SystemException
Throws:
SystemException

getEvents

public static List<CalEvent> getEvents(long groupId,
                                       Calendar cal,
                                       String type)
                                throws SystemException
Throws:
SystemException

getEvents

public static List<CalEvent> getEvents(long groupId,
                                       Calendar cal,
                                       String[] types)
                                throws SystemException
Throws:
SystemException

getEvents

public static List<CalEvent> getEvents(long groupId,
                                       String type,
                                       int start,
                                       int end)
                                throws SystemException
Throws:
SystemException

getEvents

public static List<CalEvent> getEvents(long groupId,
                                       String[] types,
                                       int start,
                                       int end)
                                throws SystemException
Throws:
SystemException

getEventsCount

public static int getEventsCount(long groupId,
                                 String type)
                          throws SystemException
Throws:
SystemException

getEventsCount

public static int getEventsCount(long groupId,
                                 String[] types)
                          throws SystemException
Throws:
SystemException

getNoAssetEvents

public static List<CalEvent> getNoAssetEvents()
                                       throws SystemException
Throws:
SystemException

getRepeatingEvents

public static List<CalEvent> getRepeatingEvents(long groupId)
                                         throws SystemException
Throws:
SystemException

getRepeatingEvents

public static List<CalEvent> getRepeatingEvents(long groupId,
                                                Calendar cal,
                                                String[] types)
                                         throws SystemException
Throws:
SystemException

hasEvents

public static boolean hasEvents(long groupId,
                                Calendar cal)
                         throws SystemException
Throws:
SystemException

hasEvents

public static boolean hasEvents(long groupId,
                                Calendar cal,
                                String type)
                         throws SystemException
Throws:
SystemException

hasEvents

public static boolean hasEvents(long groupId,
                                Calendar cal,
                                String[] types)
                         throws SystemException
Throws:
SystemException

importICal4j

public static void importICal4j(long userId,
                                long groupId,
                                InputStream inputStream)
                         throws PortalException,
                                SystemException
Throws:
PortalException
SystemException

updateAsset

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

updateEvent

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

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

getService

public static CalEventLocalService getService()

setService

public void setService(CalEventLocalService service)
Deprecated. As of 6.2.0


Liferay 6.2-ce-ga5