com.liferay.calendar.service

Class CalendarLocalServiceUtil

java.lang.Object

com.liferay.calendar.service.CalendarLocalServiceUtil

@ProviderType
public class CalendarLocalServiceUtil
extends java.lang.Object

Provides the local service utility for Calendar. This utility wraps com.liferay.calendar.service.impl.CalendarLocalServiceImpl 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:

CalendarLocalService, com.liferay.calendar.service.base.CalendarLocalServiceBaseImpl, com.liferay.calendar.service.impl.CalendarLocalServiceImpl

Generated:

Constructor Summary

Constructors

Constructor and Description
CalendarLocalServiceUtil()

Method Summary

Modifier and Type	Method and Description
static Calendar	addCalendar(Calendar calendar) Adds the calendar to the database.
static Calendar	addCalendar(long userId, long groupId, long calendarResourceId, java.util.Map<java.util.Locale,java.lang.String> nameMap, java.util.Map<java.util.Locale,java.lang.String> descriptionMap, java.lang.String timeZoneId, int color, boolean defaultCalendar, boolean enableComments, boolean enableRatings, com.liferay.portal.kernel.service.ServiceContext serviceContext)
static Calendar	createCalendar(long calendarId) Creates a new calendar with the primary key.
static Calendar	deleteCalendar(Calendar calendar) Deletes the calendar from the database.
static Calendar	deleteCalendar(long calendarId) Deletes the calendar with the primary key from the database.
static com.liferay.portal.kernel.model.PersistedModel	deletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel)
static com.liferay.portal.kernel.dao.orm.DynamicQuery	dynamicQuery()
static <T> java.util.List<T>	dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.
static <T> java.util.List<T>	dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, int end) Performs a dynamic query on the database and returns a range of the matching rows.
static <T> java.util.List<T>	dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<T> orderByComparator) Performs a dynamic query on the database and returns an ordered range of the matching rows.
static long	dynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) Returns the number of rows matching the dynamic query.
static long	dynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, com.liferay.portal.kernel.dao.orm.Projection projection) Returns the number of rows matching the dynamic query.
static java.lang.String	exportCalendar(long calendarId, java.lang.String type)
static Calendar	fetchCalendar(long calendarId)
static Calendar	fetchCalendarByUuidAndGroupId(java.lang.String uuid, long groupId) Returns the calendar matching the UUID and group.
static com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery	getActionableDynamicQuery()
static Calendar	getCalendar(long calendarId) Returns the calendar with the primary key.
static Calendar	getCalendarByUuidAndGroupId(java.lang.String uuid, long groupId) Returns the calendar matching the UUID and group.
static java.util.List<Calendar>	getCalendarResourceCalendars(long groupId, long calendarResourceId)
static java.util.List<Calendar>	getCalendarResourceCalendars(long groupId, long calendarResourceId, boolean defaultCalendar)
static java.util.List<Calendar>	getCalendars(int start, int end) Returns a range of all the calendars.
static java.util.List<Calendar>	getCalendarsByUuidAndCompanyId(java.lang.String uuid, long companyId) Returns all the calendars matching the UUID and company.
static java.util.List<Calendar>	getCalendarsByUuidAndCompanyId(java.lang.String uuid, long companyId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<Calendar> orderByComparator) Returns a range of calendars matching the UUID and company.
static int	getCalendarsCount() Returns the number of calendars.
static com.liferay.portal.kernel.dao.orm.ExportActionableDynamicQuery	getExportActionableDynamicQuery(com.liferay.exportimport.kernel.lar.PortletDataContext portletDataContext)
static com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery	getIndexableActionableDynamicQuery()
static java.lang.String	getOSGiServiceIdentifier() Returns the OSGi service identifier.
static com.liferay.portal.kernel.model.PersistedModel	getPersistedModel(java.io.Serializable primaryKeyObj)
static CalendarLocalService	getService()
static boolean	hasStagingCalendar(Calendar calendar)
static void	importCalendar(long calendarId, java.lang.String data, java.lang.String type)
static boolean	isStagingCalendar(Calendar calendar)
static java.util.List<Calendar>	search(long companyId, long[] groupIds, long[] calendarResourceIds, java.lang.String keywords, boolean andOperator, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<Calendar> orderByComparator)
static java.util.List<Calendar>	search(long companyId, long[] groupIds, long[] calendarResourceIds, java.lang.String name, java.lang.String description, boolean andOperator, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<Calendar> orderByComparator)
static int	searchCount(long companyId, long[] groupIds, long[] calendarResourceIds, java.lang.String keywords, boolean andOperator)
static int	searchCount(long companyId, long[] groupIds, long[] calendarResourceIds, java.lang.String name, java.lang.String description, boolean andOperator)
static Calendar	updateCalendar(Calendar calendar) Updates the calendar in the database or adds it if it does not yet exist.
static void	updateCalendar(long calendarId, boolean defaultCalendar)
static Calendar	updateCalendar(long calendarId, java.util.Map<java.util.Locale,java.lang.String> nameMap, java.util.Map<java.util.Locale,java.lang.String> descriptionMap, int color, com.liferay.portal.kernel.service.ServiceContext serviceContext)
static Calendar	updateCalendar(long calendarId, java.util.Map<java.util.Locale,java.lang.String> nameMap, java.util.Map<java.util.Locale,java.lang.String> descriptionMap, java.lang.String timeZoneId, int color, boolean defaultCalendar, boolean enableComments, boolean enableRatings, com.liferay.portal.kernel.service.ServiceContext serviceContext)
static Calendar	updateColor(long calendarId, int color, com.liferay.portal.kernel.service.ServiceContext serviceContext)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CalendarLocalServiceUtil

public CalendarLocalServiceUtil()

Method Detail

addCalendar

public static Calendar addCalendar(Calendar calendar)

Adds the calendar to the database. Also notifies the appropriate model listeners.

Parameters:

calendar - the calendar

Returns:

the calendar that was added

addCalendar

public static Calendar addCalendar(long userId,
                                   long groupId,
                                   long calendarResourceId,
                                   java.util.Map<java.util.Locale,java.lang.String> nameMap,
                                   java.util.Map<java.util.Locale,java.lang.String> descriptionMap,
                                   java.lang.String timeZoneId,
                                   int color,
                                   boolean defaultCalendar,
                                   boolean enableComments,
                                   boolean enableRatings,
                                   com.liferay.portal.kernel.service.ServiceContext serviceContext)
                            throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

createCalendar

public static Calendar createCalendar(long calendarId)

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

Parameters:

calendarId - the primary key for the new calendar

Returns:

the new calendar

deleteCalendar

public static Calendar deleteCalendar(Calendar calendar)
                               throws com.liferay.portal.kernel.exception.PortalException

Deletes the calendar from the database. Also notifies the appropriate model listeners.

Parameters:

calendar - the calendar

Returns:

the calendar that was removed

Throws:

PortalException

deleteCalendar

public static Calendar deleteCalendar(long calendarId)
                               throws com.liferay.portal.kernel.exception.PortalException

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

Parameters:

calendarId - the primary key of the calendar

Returns:

the calendar that was removed

Throws:

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

deletePersistedModel

public static com.liferay.portal.kernel.model.PersistedModel deletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel)
                                                                           throws com.liferay.portal.kernel.exception.PortalException

Throws:

PortalException

dynamicQuery

public static com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery()

dynamicQuery

public static <T> java.util.List<T> dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)

Performs a dynamic query on the database and returns the matching rows.

Parameters:

dynamicQuery - the dynamic query

Returns:

the matching rows

dynamicQuery

public static <T> java.util.List<T> dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery,
                                                 int start,
                                                 int end)

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

dynamicQuery

public static <T> java.util.List<T> dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery,
                                                 int start,
                                                 int end,
                                                 com.liferay.portal.kernel.util.OrderByComparator<T> orderByComparator)

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

dynamicQueryCount

public static long dynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)

Returns the number of rows matching the dynamic query.

Parameters:

dynamicQuery - the dynamic query

Returns:

the number of rows matching the dynamic query

dynamicQueryCount

public static long dynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery,
                                     com.liferay.portal.kernel.dao.orm.Projection projection)

Returns the number of rows matching the dynamic query.

Parameters:

dynamicQuery - the dynamic query

projection - the projection to apply to the query

Returns:

the number of rows matching the dynamic query

exportCalendar

public static java.lang.String exportCalendar(long calendarId,
                                              java.lang.String type)
                                       throws java.lang.Exception

Throws:

java.lang.Exception

fetchCalendar

public static Calendar fetchCalendar(long calendarId)

fetchCalendarByUuidAndGroupId

public static Calendar fetchCalendarByUuidAndGroupId(java.lang.String uuid,
                                                     long groupId)

Returns the calendar matching the UUID and group.

Parameters:

uuid - the calendar's UUID

groupId - the primary key of the group

Returns:

the matching calendar, or null if a matching calendar could not be found

getActionableDynamicQuery

public static com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery()

getCalendar

public static Calendar getCalendar(long calendarId)
                            throws com.liferay.portal.kernel.exception.PortalException

Returns the calendar with the primary key.

Parameters:

calendarId - the primary key of the calendar

Returns:

the calendar

Throws:

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

getCalendarByUuidAndGroupId

public static Calendar getCalendarByUuidAndGroupId(java.lang.String uuid,
                                                   long groupId)
                                            throws com.liferay.portal.kernel.exception.PortalException

Returns the calendar matching the UUID and group.

Parameters:

uuid - the calendar's UUID

groupId - the primary key of the group

Returns:

the matching calendar

Throws:

PortalException - if a matching calendar could not be found

getCalendarResourceCalendars

public static java.util.List<Calendar> getCalendarResourceCalendars(long groupId,
                                                                    long calendarResourceId)

getCalendarResourceCalendars

public static java.util.List<Calendar> getCalendarResourceCalendars(long groupId,
                                                                    long calendarResourceId,
                                                                    boolean defaultCalendar)

getCalendars

public static java.util.List<Calendar> getCalendars(int start,
                                                    int end)

Returns a range of all the calendars.

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

end - the upper bound of the range of calendars (not inclusive)

Returns:

the range of calendars

getCalendarsByUuidAndCompanyId

public static java.util.List<Calendar> getCalendarsByUuidAndCompanyId(java.lang.String uuid,
                                                                      long companyId)

Returns all the calendars matching the UUID and company.

Parameters:

uuid - the UUID of the calendars

companyId - the primary key of the company

Returns:

the matching calendars, or an empty list if no matches were found

getCalendarsByUuidAndCompanyId

public static java.util.List<Calendar> getCalendarsByUuidAndCompanyId(java.lang.String uuid,
                                                                      long companyId,
                                                                      int start,
                                                                      int end,
                                                                      com.liferay.portal.kernel.util.OrderByComparator<Calendar> orderByComparator)

Returns a range of calendars matching the UUID and company.

Parameters:

uuid - the UUID of the calendars

companyId - the primary key of the company

start - the lower bound of the range of calendars

end - the upper bound of the range of calendars (not inclusive)

orderByComparator - the comparator to order the results by (optionally null)

Returns:

the range of matching calendars, or an empty list if no matches were found

getCalendarsCount

public static int getCalendarsCount()

Returns the number of calendars.

Returns:

the number of calendars

getExportActionableDynamicQuery

public static com.liferay.portal.kernel.dao.orm.ExportActionableDynamicQuery getExportActionableDynamicQuery(com.liferay.exportimport.kernel.lar.PortletDataContext portletDataContext)

getIndexableActionableDynamicQuery

public static com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()

getOSGiServiceIdentifier

public static java.lang.String getOSGiServiceIdentifier()

Returns the OSGi service identifier.

Returns:

the OSGi service identifier

getPersistedModel

public static com.liferay.portal.kernel.model.PersistedModel getPersistedModel(java.io.Serializable primaryKeyObj)
                                                                        throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

hasStagingCalendar

public static boolean hasStagingCalendar(Calendar calendar)
                                  throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

importCalendar

public static void importCalendar(long calendarId,
                                  java.lang.String data,
                                  java.lang.String type)
                           throws java.lang.Exception

Throws:

java.lang.Exception

isStagingCalendar

public static boolean isStagingCalendar(Calendar calendar)

search

public static java.util.List<Calendar> search(long companyId,
                                              long[] groupIds,
                                              long[] calendarResourceIds,
                                              java.lang.String keywords,
                                              boolean andOperator,
                                              int start,
                                              int end,
                                              com.liferay.portal.kernel.util.OrderByComparator<Calendar> orderByComparator)

search

public static java.util.List<Calendar> search(long companyId,
                                              long[] groupIds,
                                              long[] calendarResourceIds,
                                              java.lang.String name,
                                              java.lang.String description,
                                              boolean andOperator,
                                              int start,
                                              int end,
                                              com.liferay.portal.kernel.util.OrderByComparator<Calendar> orderByComparator)

searchCount

public static int searchCount(long companyId,
                              long[] groupIds,
                              long[] calendarResourceIds,
                              java.lang.String keywords,
                              boolean andOperator)

searchCount

public static int searchCount(long companyId,
                              long[] groupIds,
                              long[] calendarResourceIds,
                              java.lang.String name,
                              java.lang.String description,
                              boolean andOperator)

updateCalendar

public static Calendar updateCalendar(Calendar calendar)

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

Parameters:

calendar - the calendar

Returns:

the calendar that was updated

updateCalendar

public static void updateCalendar(long calendarId,
                                  boolean defaultCalendar)
                           throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

updateCalendar

public static Calendar updateCalendar(long calendarId,
                                      java.util.Map<java.util.Locale,java.lang.String> nameMap,
                                      java.util.Map<java.util.Locale,java.lang.String> descriptionMap,
                                      int color,
                                      com.liferay.portal.kernel.service.ServiceContext serviceContext)
                               throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

updateCalendar

public static Calendar updateCalendar(long calendarId,
                                      java.util.Map<java.util.Locale,java.lang.String> nameMap,
                                      java.util.Map<java.util.Locale,java.lang.String> descriptionMap,
                                      java.lang.String timeZoneId,
                                      int color,
                                      boolean defaultCalendar,
                                      boolean enableComments,
                                      boolean enableRatings,
                                      com.liferay.portal.kernel.service.ServiceContext serviceContext)
                               throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

updateColor

public static Calendar updateColor(long calendarId,
                                   int color,
                                   com.liferay.portal.kernel.service.ServiceContext serviceContext)
                            throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

getService

public static CalendarLocalService getService()