Interface CalendarLocalService

All Superinterfaces:
com.liferay.portal.kernel.service.BaseLocalService, com.liferay.portal.kernel.service.change.tracking.CTService<Calendar>, com.liferay.portal.kernel.service.PersistedModelLocalService
All Known Implementing Classes:
CalendarLocalServiceWrapper

@CTAware @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.change.tracking.CTService<Calendar>, com.liferay.portal.kernel.service.PersistedModelLocalService
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:
Generated:
  • Method Details

    • addCalendar

      @Indexable(type=REINDEX) Calendar addCalendar(Calendar calendar)
      Adds the calendar to the database. Also notifies the appropriate model listeners.

      Important: Inspect CalendarLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.

      Parameters:
      calendar - the calendar
      Returns:
      the calendar that was added
    • addCalendar

      @Indexable(type=REINDEX) Calendar addCalendar(long userId, long groupId, long calendarResourceId, Map<Locale,String> nameMap, Map<Locale,String> descriptionMap, 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

      @Transactional(enabled=false) 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
    • createPersistedModel

      com.liferay.portal.kernel.model.PersistedModel createPersistedModel(Serializable primaryKeyObj) throws com.liferay.portal.kernel.exception.PortalException
      Specified by:
      createPersistedModel in interface com.liferay.portal.kernel.service.PersistedModelLocalService
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • 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.

      Important: Inspect CalendarLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.

      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.

      Important: Inspect CalendarLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.

      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
    • 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
    • dslQuery

      @Transactional(propagation=SUPPORTS, readOnly=true) <T> T dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)
      Specified by:
      dslQuery in interface com.liferay.portal.kernel.service.PersistedModelLocalService
    • dslQueryCount

      @Transactional(propagation=SUPPORTS, readOnly=true) int dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)
      Specified by:
      dslQueryCount in interface com.liferay.portal.kernel.service.PersistedModelLocalService
    • dynamicQuery

      @Transactional(propagation=SUPPORTS, readOnly=true) com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery()
    • dynamicQuery

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

      @Transactional(propagation=SUPPORTS, readOnly=true) <T> 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 com.liferay.portal.kernel.dao.orm.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, then the query will include the default ORDER BY logic from com.liferay.calendar.model.impl.CalendarModelImpl.

      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

      @Transactional(propagation=SUPPORTS, readOnly=true) <T> 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 com.liferay.portal.kernel.dao.orm.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, then the query will include the default ORDER BY logic from com.liferay.calendar.model.impl.CalendarModelImpl.

      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

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

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

      String exportCalendar(long calendarId, String type) throws Exception
      Throws:
      Exception
    • fetchCalendar

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

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

      @Transactional(propagation=SUPPORTS, readOnly=true) Calendar fetchGroupCalendar(long companyId, long groupId, String name)
    • getActionableDynamicQuery

      @Transactional(propagation=SUPPORTS, readOnly=true) com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery()
    • 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(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
    • getCalendarResourceCalendars

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

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

      @Transactional(propagation=SUPPORTS, readOnly=true) 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 com.liferay.portal.kernel.dao.orm.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, then the query will include the default ORDER BY logic from com.liferay.calendar.model.impl.CalendarModelImpl.

      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) List<Calendar> getCalendarsByUuidAndCompanyId(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) List<Calendar> getCalendarsByUuidAndCompanyId(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

      @Transactional(propagation=SUPPORTS, readOnly=true) int getCalendarsCount()
      Returns the number of calendars.
      Returns:
      the number of calendars
    • 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()
    • getOSGiServiceIdentifier

      String getOSGiServiceIdentifier()
      Returns the OSGi service identifier.
      Returns:
      the OSGi service identifier
    • getPersistedModel

      @Transactional(propagation=SUPPORTS, readOnly=true) com.liferay.portal.kernel.model.PersistedModel getPersistedModel(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
    • hasStagingCalendar

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

      void importCalendar(long calendarId, String data, String type) throws Exception
      Throws:
      Exception
    • isStagingCalendar

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

      @Transactional(propagation=SUPPORTS, readOnly=true) List<Calendar> search(long companyId, long[] groupIds, long[] calendarResourceIds, String keywords, boolean andOperator, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<Calendar> orderByComparator)
    • search

      @Transactional(propagation=SUPPORTS, readOnly=true) List<Calendar> search(long companyId, long[] groupIds, long[] calendarResourceIds, String name, String description, boolean andOperator, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<Calendar> orderByComparator)
    • searchCount

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

      @Transactional(propagation=SUPPORTS, readOnly=true) int searchCount(long companyId, long[] groupIds, long[] calendarResourceIds, String name, String description, boolean andOperator)
    • 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.

      Important: Inspect CalendarLocalServiceImpl for overloaded versions of the method. If provided, use these entry points to the API, as the implementation logic may require the additional parameters defined there.

      Parameters:
      calendar - the calendar
      Returns:
      the calendar that was updated
    • updateCalendar

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

      Calendar updateCalendar(long calendarId, Map<Locale,String> nameMap, Map<Locale,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, Map<Locale,String> nameMap, Map<Locale,String> descriptionMap, 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
    • getCTPersistence

      @Transactional(enabled=false) com.liferay.portal.kernel.service.persistence.change.tracking.CTPersistence<Calendar> getCTPersistence()
      Specified by:
      getCTPersistence in interface com.liferay.portal.kernel.service.change.tracking.CTService<Calendar>
    • getModelClass

      @Transactional(enabled=false) Class<Calendar> getModelClass()
      Specified by:
      getModelClass in interface com.liferay.portal.kernel.service.change.tracking.CTService<Calendar>
    • updateWithUnsafeFunction

      @Transactional(rollbackFor=java.lang.Throwable.class) <R, E extends Throwable> R updateWithUnsafeFunction(com.liferay.petra.function.UnsafeFunction<com.liferay.portal.kernel.service.persistence.change.tracking.CTPersistence<Calendar>,R,E> updateUnsafeFunction) throws E
      Specified by:
      updateWithUnsafeFunction in interface com.liferay.portal.kernel.service.change.tracking.CTService<Calendar>
      Throws:
      E extends Throwable