com.liferay.calendar.service

Interface CalendarLocalService

All Superinterfaces:

com.liferay.portal.kernel.service.BaseLocalService, com.liferay.portal.kernel.service.PermissionedModelLocalService, com.liferay.portal.kernel.service.PersistedModelLocalService

All Known Implementing Classes:

CalendarLocalServiceWrapper

@ProviderType
 @Transactional(isolation=PORTAL,
               rollbackFor={com.liferay.portal.kernel.exception.PortalException.class,com.liferay.portal.kernel.exception.SystemException.class})
public interface CalendarLocalService
extends com.liferay.portal.kernel.service.BaseLocalService, com.liferay.portal.kernel.service.PermissionedModelLocalService

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

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

Generated:

Method Summary

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

Method Detail

hasStagingCalendar

@Transactional(propagation=SUPPORTS,
               readOnly=true)
boolean hasStagingCalendar(Calendar calendar)
                                                                                       throws com.liferay.portal.kernel.exception.PortalException

Throws:

com.liferay.portal.kernel.exception.PortalException

isStagingCalendar

@Transactional(propagation=SUPPORTS,
               readOnly=true)
boolean isStagingCalendar(Calendar calendar)

addCalendar

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

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

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

@Indexable(type=DELETE)
 @SystemEvent(action=1,
             type=1)
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:

com.liferay.portal.kernel.exception.PortalException

deleteCalendar

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

com.liferay.portal.kernel.exception.PortalException - if a calendar with the primary key could not be found

fetchCalendar

@Transactional(propagation=SUPPORTS,
               readOnly=true)
Calendar fetchCalendar(long calendarId)

fetchCalendarByUuidAndGroupId

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

getCalendar

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

com.liferay.portal.kernel.exception.PortalException - if a calendar with the primary key could not be found

getCalendarByUuidAndGroupId

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

com.liferay.portal.kernel.exception.PortalException - if a matching calendar could not be found

updateCalendar

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

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

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

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

getActionableDynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery()

dynamicQuery

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

getExportActionableDynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
com.liferay.portal.kernel.dao.orm.ExportActionableDynamicQuery getExportActionableDynamicQuery(com.liferay.exportimport.kernel.lar.PortletDataContext portletDataContext)

getIndexableActionableDynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()

deletePersistedModel

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

Specified by:

deletePersistedModel in interface com.liferay.portal.kernel.service.PersistedModelLocalService

Throws:

com.liferay.portal.kernel.exception.PortalException

getPersistedModel

@Transactional(propagation=SUPPORTS,
               readOnly=true)
com.liferay.portal.kernel.model.PersistedModel getPersistedModel(java.io.Serializable primaryKeyObj)
                                                                                                                             throws com.liferay.portal.kernel.exception.PortalException

Specified by:

getPersistedModel in interface com.liferay.portal.kernel.service.PersistedModelLocalService

Throws:

com.liferay.portal.kernel.exception.PortalException

getCalendarsCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getCalendarsCount()

Returns the number of calendars.

Returns:

the number of calendars

searchCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int searchCount(long companyId,
                                                                                   long[] groupIds,
                                                                                   long[] calendarResourceIds,
                                                                                   java.lang.String keywords,
                                                                                   boolean andOperator)

searchCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int searchCount(long companyId,
                                                                                   long[] groupIds,
                                                                                   long[] calendarResourceIds,
                                                                                   java.lang.String name,
                                                                                   java.lang.String description,
                                                                                   boolean andOperator)

exportCalendar

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

Throws:

java.lang.Exception

getOSGiServiceIdentifier

java.lang.String getOSGiServiceIdentifier()

Returns the OSGi service identifier.

Returns:

the OSGi service identifier

dynamicQuery

<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

<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

<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

getCalendarResourceCalendars

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<Calendar> getCalendarResourceCalendars(long groupId,
                                                                                                                         long calendarResourceId)

getCalendarResourceCalendars

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<Calendar> getCalendarResourceCalendars(long groupId,
                                                                                                                         long calendarResourceId,
                                                                                                                         boolean defaultCalendar)

getCalendars

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

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

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

search

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

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

dynamicQueryCount

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

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

importCalendar

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

Throws:

java.lang.Exception

updateCalendar

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

Throws:

com.liferay.portal.kernel.exception.PortalException