Class CalendarLocalServiceUtil

java.lang.Object
com.liferay.calendar.service.CalendarLocalServiceUtil

public class CalendarLocalServiceUtil extends Object
Provides the local service utility for Calendar. This utility wraps com.liferay.calendar.service.impl.CalendarLocalServiceImpl and is an 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:
Generated:
  • Constructor Details

    • CalendarLocalServiceUtil

      public CalendarLocalServiceUtil()
  • Method Details

    • addCalendar

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

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

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

      public static com.liferay.portal.kernel.model.PersistedModel createPersistedModel(Serializable primaryKeyObj) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • 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.

      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

      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.

      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

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

      public static <T> T dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)
    • dslQueryCount

      public static int dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)
    • dynamicQuery

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

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

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

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

      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 String exportCalendar(long calendarId, String type) throws Exception
      Throws:
      Exception
    • fetchCalendar

      public static Calendar fetchCalendar(long calendarId)
    • fetchCalendarByUuidAndGroupId

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

      public static Calendar fetchGroupCalendar(long companyId, long groupId, String name)
    • 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:
      com.liferay.portal.kernel.exception.PortalException - if a calendar with the primary key could not be found
    • getCalendarByUuidAndGroupId

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

      public static List<Calendar> getCalendarResourceCalendars(long groupId, long calendarResourceId)
    • getCalendarResourceCalendars

      public static List<Calendar> getCalendarResourceCalendars(long groupId, long calendarResourceId, boolean defaultCalendar)
    • getCalendars

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

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

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

      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 String getOSGiServiceIdentifier()
      Returns the OSGi service identifier.
      Returns:
      the OSGi service identifier
    • getPersistedModel

      public static com.liferay.portal.kernel.model.PersistedModel getPersistedModel(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, String data, String type) throws Exception
      Throws:
      Exception
    • isStagingCalendar

      public static boolean isStagingCalendar(Calendar calendar)
    • search

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

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

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

      public static int searchCount(long companyId, long[] groupIds, long[] calendarResourceIds, String name, 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.

      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

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

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

      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()