Class SXPBlueprintLocalServiceUtil

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

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

    • SXPBlueprintLocalServiceUtil

      public SXPBlueprintLocalServiceUtil()
  • Method Details

    • addSXPBlueprint

      public static SXPBlueprint addSXPBlueprint(String externalReferenceCode, long userId, String configurationJSON, Map<Locale,String> descriptionMap, String elementInstancesJSON, 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
    • addSXPBlueprint

      public static SXPBlueprint addSXPBlueprint(SXPBlueprint sxpBlueprint)
      Adds the sxp blueprint to the database. Also notifies the appropriate model listeners.

      Important: Inspect SXPBlueprintLocalServiceImpl 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:
      sxpBlueprint - the sxp blueprint
      Returns:
      the sxp blueprint 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
    • createSXPBlueprint

      public static SXPBlueprint createSXPBlueprint(long sxpBlueprintId)
      Creates a new sxp blueprint with the primary key. Does not add the sxp blueprint to the database.
      Parameters:
      sxpBlueprintId - the primary key for the new sxp blueprint
      Returns:
      the new sxp blueprint
    • deleteCompanySXPBlueprints

      public static void deleteCompanySXPBlueprints(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
    • deleteSXPBlueprint

      public static SXPBlueprint deleteSXPBlueprint(long sxpBlueprintId) throws com.liferay.portal.kernel.exception.PortalException
      Deletes the sxp blueprint with the primary key from the database. Also notifies the appropriate model listeners.

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

      public static SXPBlueprint deleteSXPBlueprint(SXPBlueprint sxpBlueprint) throws com.liferay.portal.kernel.exception.PortalException
      Deletes the sxp blueprint from the database. Also notifies the appropriate model listeners.

      Important: Inspect SXPBlueprintLocalServiceImpl 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:
      sxpBlueprint - the sxp blueprint
      Returns:
      the sxp blueprint 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.SXPBlueprintModelImpl.

      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.SXPBlueprintModelImpl.

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

      public static SXPBlueprint fetchSXPBlueprint(long sxpBlueprintId)
    • fetchSXPBlueprintByExternalReferenceCode

      public static SXPBlueprint fetchSXPBlueprintByExternalReferenceCode(String externalReferenceCode, long companyId)
    • fetchSXPBlueprintByUuidAndCompanyId

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

      public static SXPBlueprint getSXPBlueprint(long sxpBlueprintId) throws com.liferay.portal.kernel.exception.PortalException
      Returns the sxp blueprint with the primary key.
      Parameters:
      sxpBlueprintId - the primary key of the sxp blueprint
      Returns:
      the sxp blueprint
      Throws:
      com.liferay.portal.kernel.exception.PortalException - if a sxp blueprint with the primary key could not be found
    • getSXPBlueprintByExternalReferenceCode

      public static SXPBlueprint getSXPBlueprintByExternalReferenceCode(String externalReferenceCode, long companyId) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • getSXPBlueprintByUuidAndCompanyId

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

      public static List<SXPBlueprint> getSXPBlueprints(int start, int end)
      Returns a range of all the sxp blueprints.

      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.SXPBlueprintModelImpl.

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

      public static List<SXPBlueprint> getSXPBlueprints(long companyId)
    • getSXPBlueprintsCount

      public static int getSXPBlueprintsCount()
      Returns the number of sxp blueprints.
      Returns:
      the number of sxp blueprints
    • getSXPBlueprintsCount

      public static int getSXPBlueprintsCount(long companyId)
    • updateStatus

      public static SXPBlueprint updateStatus(long userId, long sxpBlueprintId, int status, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException
      Throws:
      com.liferay.portal.kernel.exception.PortalException
    • updateSXPBlueprint

      public static SXPBlueprint updateSXPBlueprint(String externalReferenceCode, long userId, long sxpBlueprintId, String configurationJSON, Map<Locale,String> descriptionMap, String elementInstancesJSON, 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
    • updateSXPBlueprint

      public static SXPBlueprint updateSXPBlueprint(SXPBlueprint sxpBlueprint)
      Updates the sxp blueprint in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

      Important: Inspect SXPBlueprintLocalServiceImpl 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:
      sxpBlueprint - the sxp blueprint
      Returns:
      the sxp blueprint that was updated
    • getService

      public static SXPBlueprintLocalService getService()