Class SXPElementLocalServiceUtil

java.lang.Object
com.liferay.search.experiences.service.SXPElementLocalServiceUtil

public class SXPElementLocalServiceUtil extends Object
Provides the local service utility for SXPElement. This utility wraps com.liferay.search.experiences.service.impl.SXPElementLocalServiceImpl 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

    • SXPElementLocalServiceUtil

      public SXPElementLocalServiceUtil()
  • Method Details

    • addSXPElement

      public static SXPElement addSXPElement(String externalReferenceCode, long userId, Map<Locale,String> descriptionMap, String elementDefinitionJSON, String fallbackDescription, String fallbackTitle, boolean readOnly, String schemaVersion, Map<Locale,String> titleMap, int type, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • addSXPElement

      public static SXPElement addSXPElement(SXPElement sxpElement)
      Adds the sxp element to the database. Also notifies the appropriate model listeners.

      Important: Inspect SXPElementLocalServiceImpl 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:
      sxpElement - the sxp element
      Returns:
      the sxp element 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
    • createSXPElement

      public static SXPElement createSXPElement(long sxpElementId)
      Creates a new sxp element with the primary key. Does not add the sxp element to the database.
      Parameters:
      sxpElementId - the primary key for the new sxp element
      Returns:
      the new sxp element
    • deleteCompanySXPElements

      public static void deleteCompanySXPElements(long companyId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • 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
    • deleteSXPElement

      public static SXPElement deleteSXPElement(long sxpElementId) throws com.liferay.portal.kernel.exception.PortalException
      Deletes the sxp element with the primary key from the database. Also notifies the appropriate model listeners.

      Important: Inspect SXPElementLocalServiceImpl 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:
      sxpElementId - the primary key of the sxp element
      Returns:
      the sxp element that was removed
      Throws:
      com.liferay.portal.kernel.exception.PortalException - if a sxp element with the primary key could not be found
    • deleteSXPElement

      public static SXPElement deleteSXPElement(SXPElement sxpElement) throws com.liferay.portal.kernel.exception.PortalException
      Deletes the sxp element from the database. Also notifies the appropriate model listeners.

      Important: Inspect SXPElementLocalServiceImpl 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:
      sxpElement - the sxp element
      Returns:
      the sxp element 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.search.experiences.model.impl.SXPElementModelImpl.

      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.search.experiences.model.impl.SXPElementModelImpl.

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

      public static SXPElement fetchSXPElement(long sxpElementId)
    • fetchSXPElementByExternalReferenceCode

      public static SXPElement fetchSXPElementByExternalReferenceCode(String externalReferenceCode, long companyId)
    • fetchSXPElementByUuidAndCompanyId

      public static SXPElement fetchSXPElementByUuidAndCompanyId(String uuid, long companyId)
      Returns the sxp element with the matching UUID and company.
      Parameters:
      uuid - the sxp element's UUID
      companyId - the primary key of the company
      Returns:
      the matching sxp element, or null if a matching sxp element 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
    • getSXPElement

      public static SXPElement getSXPElement(long sxpElementId) throws com.liferay.portal.kernel.exception.PortalException
      Returns the sxp element with the primary key.
      Parameters:
      sxpElementId - the primary key of the sxp element
      Returns:
      the sxp element
      Throws:
      com.liferay.portal.kernel.exception.PortalException - if a sxp element with the primary key could not be found
    • getSXPElementByExternalReferenceCode

      public static SXPElement getSXPElementByExternalReferenceCode(String externalReferenceCode, long companyId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getSXPElementByUuidAndCompanyId

      public static SXPElement getSXPElementByUuidAndCompanyId(String uuid, long companyId) throws com.liferay.portal.kernel.exception.PortalException
      Returns the sxp element with the matching UUID and company.
      Parameters:
      uuid - the sxp element's UUID
      companyId - the primary key of the company
      Returns:
      the matching sxp element
      Throws:
      com.liferay.portal.kernel.exception.PortalException - if a matching sxp element could not be found
    • getSXPElements

      public static List<SXPElement> getSXPElements(int start, int end)
      Returns a range of all the sxp elements.

      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.search.experiences.model.impl.SXPElementModelImpl.

      Parameters:
      start - the lower bound of the range of sxp elements
      end - the upper bound of the range of sxp elements (not inclusive)
      Returns:
      the range of sxp elements
    • getSXPElements

      public static List<SXPElement> getSXPElements(long companyId, boolean readOnly)
    • getSXPElementsCount

      public static int getSXPElementsCount()
      Returns the number of sxp elements.
      Returns:
      the number of sxp elements
    • updateStatus

      public static SXPElement updateStatus(long userId, long sxpElementId, int status) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • updateSXPElement

      public static SXPElement updateSXPElement(String externalReferenceCode, long userId, long sxpElementId, Map<Locale,String> descriptionMap, String elementDefinitionJSON, boolean hidden, String schemaVersion, Map<Locale,String> titleMap, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • updateSXPElement

      public static SXPElement updateSXPElement(SXPElement sxpElement)
      Updates the sxp element in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

      Important: Inspect SXPElementLocalServiceImpl 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:
      sxpElement - the sxp element
      Returns:
      the sxp element that was updated
    • getService

      public static SXPElementLocalService getService()