Class RedirectEntryLocalServiceUtil

java.lang.Object
com.liferay.redirect.service.RedirectEntryLocalServiceUtil

public class RedirectEntryLocalServiceUtil extends Object
Provides the local service utility for RedirectEntry. This utility wraps com.liferay.redirect.service.impl.RedirectEntryLocalServiceImpl 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

    • RedirectEntryLocalServiceUtil

      public RedirectEntryLocalServiceUtil()
  • Method Details

    • addEntryResources

      public static void addEntryResources(RedirectEntry entry, boolean addGroupPermissions, boolean addGuestPermissions) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • addEntryResources

      public static void addEntryResources(RedirectEntry entry, com.liferay.portal.kernel.service.permission.ModelPermissions modelPermissions) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • addRedirectEntry

      public static RedirectEntry addRedirectEntry(long groupId, String destinationURL, Date expirationDate, boolean permanent, String sourceURL, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • addRedirectEntry

      public static RedirectEntry addRedirectEntry(long groupId, String destinationURL, Date expirationDate, String groupBaseURL, boolean permanent, String sourceURL, boolean updateChainedRedirectEntries, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • addRedirectEntry

      public static RedirectEntry addRedirectEntry(RedirectEntry redirectEntry)
      Adds the redirect entry to the database. Also notifies the appropriate model listeners.

      Important: Inspect RedirectEntryLocalServiceImpl 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:
      redirectEntry - the redirect entry
      Returns:
      the redirect entry that was added
    • 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
    • createRedirectEntry

      public static RedirectEntry createRedirectEntry(long redirectEntryId)
      Creates a new redirect entry with the primary key. Does not add the redirect entry to the database.
      Parameters:
      redirectEntryId - the primary key for the new redirect entry
      Returns:
      the new redirect entry
    • 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
    • deleteRedirectEntries

      public static void deleteRedirectEntries(long groupId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • deleteRedirectEntry

      public static RedirectEntry deleteRedirectEntry(long redirectEntryId) throws com.liferay.portal.kernel.exception.PortalException
      Deletes the redirect entry with the primary key from the database. Also notifies the appropriate model listeners.

      Important: Inspect RedirectEntryLocalServiceImpl 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:
      redirectEntryId - the primary key of the redirect entry
      Returns:
      the redirect entry that was removed
      Throws:
      com.liferay.portal.kernel.exception.PortalException - if a redirect entry with the primary key could not be found
    • deleteRedirectEntry

      public static RedirectEntry deleteRedirectEntry(RedirectEntry redirectEntry) throws com.liferay.portal.kernel.exception.PortalException
      Deletes the redirect entry from the database. Also notifies the appropriate model listeners.

      Important: Inspect RedirectEntryLocalServiceImpl 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:
      redirectEntry - the redirect entry
      Returns:
      the redirect entry that was removed
      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.redirect.model.impl.RedirectEntryModelImpl.

      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.redirect.model.impl.RedirectEntryModelImpl.

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

      public static RedirectEntry fetchRedirectEntry(long redirectEntryId)
    • fetchRedirectEntry

      public static RedirectEntry fetchRedirectEntry(long groupId, String sourceURL)
    • fetchRedirectEntry

      public static RedirectEntry fetchRedirectEntry(long groupId, String sourceURL, boolean updateLastOccurrenceDate)
    • fetchRedirectEntryByUuidAndGroupId

      public static RedirectEntry fetchRedirectEntryByUuidAndGroupId(String uuid, long groupId)
      Returns the redirect entry matching the UUID and group.
      Parameters:
      uuid - the redirect entry's UUID
      groupId - the primary key of the group
      Returns:
      the matching redirect entry, or null if a matching redirect entry could not be found
    • getActionableDynamicQuery

      public static com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery()
    • 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
    • getRedirectEntries

      public static List<RedirectEntry> getRedirectEntries(int start, int end)
      Returns a range of all the redirect entries.

      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.redirect.model.impl.RedirectEntryModelImpl.

      Parameters:
      start - the lower bound of the range of redirect entries
      end - the upper bound of the range of redirect entries (not inclusive)
      Returns:
      the range of redirect entries
    • getRedirectEntries

      public static List<RedirectEntry> getRedirectEntries(long groupId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<RedirectEntry> orderByComparator)
    • getRedirectEntries

      public static List<RedirectEntry> getRedirectEntries(long groupId, String destinationURL)
    • getRedirectEntriesByUuidAndCompanyId

      public static List<RedirectEntry> getRedirectEntriesByUuidAndCompanyId(String uuid, long companyId)
      Returns all the redirect entries matching the UUID and company.
      Parameters:
      uuid - the UUID of the redirect entries
      companyId - the primary key of the company
      Returns:
      the matching redirect entries, or an empty list if no matches were found
    • getRedirectEntriesByUuidAndCompanyId

      public static List<RedirectEntry> getRedirectEntriesByUuidAndCompanyId(String uuid, long companyId, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<RedirectEntry> orderByComparator)
      Returns a range of redirect entries matching the UUID and company.
      Parameters:
      uuid - the UUID of the redirect entries
      companyId - the primary key of the company
      start - the lower bound of the range of redirect entries
      end - the upper bound of the range of redirect entries (not inclusive)
      orderByComparator - the comparator to order the results by (optionally null)
      Returns:
      the range of matching redirect entries, or an empty list if no matches were found
    • getRedirectEntriesCount

      public static int getRedirectEntriesCount()
      Returns the number of redirect entries.
      Returns:
      the number of redirect entries
    • getRedirectEntriesCount

      public static int getRedirectEntriesCount(long groupId)
    • getRedirectEntry

      public static RedirectEntry getRedirectEntry(long redirectEntryId) throws com.liferay.portal.kernel.exception.PortalException
      Returns the redirect entry with the primary key.
      Parameters:
      redirectEntryId - the primary key of the redirect entry
      Returns:
      the redirect entry
      Throws:
      com.liferay.portal.kernel.exception.PortalException - if a redirect entry with the primary key could not be found
    • getRedirectEntryByUuidAndGroupId

      public static RedirectEntry getRedirectEntryByUuidAndGroupId(String uuid, long groupId) throws com.liferay.portal.kernel.exception.PortalException
      Returns the redirect entry matching the UUID and group.
      Parameters:
      uuid - the redirect entry's UUID
      groupId - the primary key of the group
      Returns:
      the matching redirect entry
      Throws:
      com.liferay.portal.kernel.exception.PortalException - if a matching redirect entry could not be found
    • updateRedirectEntry

      public static RedirectEntry updateRedirectEntry(long redirectEntryId, String destinationURL, Date expirationDate, boolean permanent, String sourceURL) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • updateRedirectEntry

      public static RedirectEntry updateRedirectEntry(long redirectEntryId, String destinationURL, Date expirationDate, String groupBaseURL, boolean permanent, String sourceURL, boolean updateChainedRedirectEntries) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • updateRedirectEntry

      public static RedirectEntry updateRedirectEntry(RedirectEntry redirectEntry)
      Updates the redirect entry in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

      Important: Inspect RedirectEntryLocalServiceImpl 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:
      redirectEntry - the redirect entry
      Returns:
      the redirect entry that was updated
    • getService

      public static RedirectEntryLocalService getService()