Class WebsiteLocalServiceUtil

Object
com.liferay.portal.kernel.service.WebsiteLocalServiceUtil

public class WebsiteLocalServiceUtil extends Object
Provides the local service utility for Website. This utility wraps com.liferay.portal.service.impl.WebsiteLocalServiceImpl 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.
Author:
Brian Wing Shun Chan
See Also:
{$generated.description}
  • Constructor Details

    • WebsiteLocalServiceUtil

      public WebsiteLocalServiceUtil()
  • Method Details

    • addWebsite

      public static Website addWebsite(String externalReferenceCode, long userId, String className, long classPK, String url, long listTypeId, boolean primary, ServiceContext serviceContext) throws PortalException
      Throws:
      PortalException
    • addWebsite

      public static Website addWebsite(Website website)
      Adds the website to the database. Also notifies the appropriate model listeners.

      Important: Inspect WebsiteLocalServiceImpl 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:
      website - the website
      Returns:
      the website that was added
    • createPersistedModel

      public static PersistedModel createPersistedModel(Serializable primaryKeyObj) throws PortalException
      Throws:
      PortalException
    • createWebsite

      public static Website createWebsite(long websiteId)
      Creates a new website with the primary key. Does not add the website to the database.
      Parameters:
      websiteId - the primary key for the new website
      Returns:
      the new website
    • deletePersistedModel

      public static PersistedModel deletePersistedModel(PersistedModel persistedModel) throws PortalException
      Throws:
      PortalException
    • deleteWebsite

      public static Website deleteWebsite(long websiteId) throws PortalException
      Deletes the website with the primary key from the database. Also notifies the appropriate model listeners.

      Important: Inspect WebsiteLocalServiceImpl 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:
      websiteId - the primary key of the website
      Returns:
      the website that was removed
      Throws:
      PortalException - if a website with the primary key could not be found
    • deleteWebsite

      public static Website deleteWebsite(Website website)
      Deletes the website from the database. Also notifies the appropriate model listeners.

      Important: Inspect WebsiteLocalServiceImpl 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:
      website - the website
      Returns:
      the website that was removed
    • deleteWebsites

      public static void deleteWebsites(long companyId, String className, long classPK)
    • 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 DynamicQuery dynamicQuery()
    • dynamicQuery

      public static <T> List<T> dynamicQuery(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(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.portal.model.impl.WebsiteModelImpl.

      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(DynamicQuery dynamicQuery, int start, int end, 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.portal.model.impl.WebsiteModelImpl.

      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(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(DynamicQuery dynamicQuery, 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
    • fetchWebsite

      public static Website fetchWebsite(long websiteId)
    • fetchWebsiteByExternalReferenceCode

      public static Website fetchWebsiteByExternalReferenceCode(String externalReferenceCode, long companyId)
    • fetchWebsiteByUuidAndCompanyId

      public static Website fetchWebsiteByUuidAndCompanyId(String uuid, long companyId)
      Returns the website with the matching UUID and company.
      Parameters:
      uuid - the website's UUID
      companyId - the primary key of the company
      Returns:
      the matching website, or null if a matching website could not be found
    • getActionableDynamicQuery

      public static ActionableDynamicQuery getActionableDynamicQuery()
    • getExportActionableDynamicQuery

      public static ExportActionableDynamicQuery getExportActionableDynamicQuery(PortletDataContext portletDataContext)
    • getIndexableActionableDynamicQuery

      public static IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()
    • getOSGiServiceIdentifier

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

      public static PersistedModel getPersistedModel(Serializable primaryKeyObj) throws PortalException
      Throws:
      PortalException
    • getWebsite

      public static Website getWebsite(long websiteId) throws PortalException
      Returns the website with the primary key.
      Parameters:
      websiteId - the primary key of the website
      Returns:
      the website
      Throws:
      PortalException - if a website with the primary key could not be found
    • getWebsiteByExternalReferenceCode

      public static Website getWebsiteByExternalReferenceCode(String externalReferenceCode, long companyId) throws PortalException
      Throws:
      PortalException
    • getWebsiteByUuidAndCompanyId

      public static Website getWebsiteByUuidAndCompanyId(String uuid, long companyId) throws PortalException
      Returns the website with the matching UUID and company.
      Parameters:
      uuid - the website's UUID
      companyId - the primary key of the company
      Returns:
      the matching website
      Throws:
      PortalException - if a matching website could not be found
    • getWebsites

      public static List<Website> getWebsites()
    • getWebsites

      public static List<Website> getWebsites(int start, int end)
      Returns a range of all the websites.

      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.portal.model.impl.WebsiteModelImpl.

      Parameters:
      start - the lower bound of the range of websites
      end - the upper bound of the range of websites (not inclusive)
      Returns:
      the range of websites
    • getWebsites

      public static List<Website> getWebsites(long companyId, String className, long classPK)
    • getWebsitesCount

      public static int getWebsitesCount()
      Returns the number of websites.
      Returns:
      the number of websites
    • updateWebsite

      public static Website updateWebsite(String externalReferenceCode, long websiteId, String url, long listTypeId, boolean primary) throws PortalException
      Throws:
      PortalException
    • updateWebsite

      public static Website updateWebsite(Website website)
      Updates the website in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

      Important: Inspect WebsiteLocalServiceImpl 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:
      website - the website
      Returns:
      the website that was updated
    • getService

      public static WebsiteLocalService getService()
    • setService

      public static void setService(WebsiteLocalService service)