Class SXPBlueprintLocalServiceUtil
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 Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic SXPBlueprintaddSXPBlueprint(SXPBlueprint sxpBlueprint) Adds the sxp blueprint to the database.static SXPBlueprintaddSXPBlueprint(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) static com.liferay.portal.kernel.model.PersistedModelcreatePersistedModel(Serializable primaryKeyObj) static SXPBlueprintcreateSXPBlueprint(long sxpBlueprintId) Creates a new sxp blueprint with the primary key.static voiddeleteCompanySXPBlueprints(long companyId) static com.liferay.portal.kernel.model.PersistedModeldeletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel) static SXPBlueprintdeleteSXPBlueprint(long sxpBlueprintId) Deletes the sxp blueprint with the primary key from the database.static SXPBlueprintdeleteSXPBlueprint(SXPBlueprint sxpBlueprint) Deletes the sxp blueprint from the database.static <T> TdslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) static intdslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) static com.liferay.portal.kernel.dao.orm.DynamicQuerystatic <T> List<T> dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.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.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.static longdynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery) Returns the number of rows matching the dynamic query.static longdynamicQueryCount(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.static SXPBlueprintfetchSXPBlueprint(long sxpBlueprintId) static SXPBlueprintfetchSXPBlueprintByExternalReferenceCode(String externalReferenceCode, long companyId) static SXPBlueprintfetchSXPBlueprintByUuidAndCompanyId(String uuid, long companyId) Returns the sxp blueprint with the matching UUID and company.static com.liferay.portal.kernel.dao.orm.ActionableDynamicQuerystatic com.liferay.portal.kernel.dao.orm.ExportActionableDynamicQuerygetExportActionableDynamicQuery(com.liferay.exportimport.kernel.lar.PortletDataContext portletDataContext) static com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuerystatic StringReturns the OSGi service identifier.static com.liferay.portal.kernel.model.PersistedModelgetPersistedModel(Serializable primaryKeyObj) static SXPBlueprintLocalServicestatic SXPBlueprintgetSXPBlueprint(long sxpBlueprintId) Returns the sxp blueprint with the primary key.static SXPBlueprintgetSXPBlueprintByExternalReferenceCode(String externalReferenceCode, long companyId) static SXPBlueprintgetSXPBlueprintByUuidAndCompanyId(String uuid, long companyId) Returns the sxp blueprint with the matching UUID and company.static List<SXPBlueprint> getSXPBlueprints(int start, int end) Returns a range of all the sxp blueprints.static List<SXPBlueprint> getSXPBlueprints(long companyId) static intReturns the number of sxp blueprints.static intgetSXPBlueprintsCount(long companyId) static SXPBlueprintupdateStatus(long userId, long sxpBlueprintId, int status, com.liferay.portal.kernel.service.ServiceContext serviceContext) static SXPBlueprintupdateSXPBlueprint(SXPBlueprint sxpBlueprint) Updates the sxp blueprint in the database or adds it if it does not yet exist.static SXPBlueprintupdateSXPBlueprint(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)
-
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, throws com.liferay.portal.kernel.exception.PortalExceptionString> titleMap, com.liferay.portal.kernel.service.ServiceContext serviceContext) - Throws:
com.liferay.portal.kernel.exception.PortalException
-
addSXPBlueprint
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
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
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 - startinstances.startandendare not primary keys, they are indexes in the result set. Thus,0refers to the first result in the set. Setting bothstartandendtocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POSwill return the full result set. IforderByComparatoris specified, then the query will include the given ORDER BY logic. IforderByComparatoris absent, then the query will include the default ORDER BY logic fromcom.liferay.search.experiences.model.impl.SXPBlueprintModelImpl.- Parameters:
dynamicQuery- the dynamic querystart- the lower bound of the range of model instancesend- 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 - startinstances.startandendare not primary keys, they are indexes in the result set. Thus,0refers to the first result in the set. Setting bothstartandendtocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POSwill return the full result set. IforderByComparatoris specified, then the query will include the given ORDER BY logic. IforderByComparatoris absent, then the query will include the default ORDER BY logic fromcom.liferay.search.experiences.model.impl.SXPBlueprintModelImpl.- Parameters:
dynamicQuery- the dynamic querystart- the lower bound of the range of model instancesend- the upper bound of the range of model instances (not inclusive)orderByComparator- the comparator to order the results by (optionallynull)- 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 queryprojection- the projection to apply to the query- Returns:
- the number of rows matching the dynamic query
-
fetchSXPBlueprint
-
fetchSXPBlueprintByExternalReferenceCode
public static SXPBlueprint fetchSXPBlueprintByExternalReferenceCode(String externalReferenceCode, long companyId) -
fetchSXPBlueprintByUuidAndCompanyId
Returns the sxp blueprint with the matching UUID and company.- Parameters:
uuid- the sxp blueprint's UUIDcompanyId- the primary key of the company- Returns:
- the matching sxp blueprint, or
nullif 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
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 UUIDcompanyId- 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
Returns a range of all the sxp blueprints.Useful when paginating results. Returns a maximum of
end - startinstances.startandendare not primary keys, they are indexes in the result set. Thus,0refers to the first result in the set. Setting bothstartandendtocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POSwill return the full result set. IforderByComparatoris specified, then the query will include the given ORDER BY logic. IforderByComparatoris absent, then the query will include the default ORDER BY logic fromcom.liferay.search.experiences.model.impl.SXPBlueprintModelImpl.- Parameters:
start- the lower bound of the range of sxp blueprintsend- the upper bound of the range of sxp blueprints (not inclusive)- Returns:
- the range of sxp blueprints
-
getSXPBlueprints
-
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, throws com.liferay.portal.kernel.exception.PortalExceptionString> titleMap, com.liferay.portal.kernel.service.ServiceContext serviceContext) - Throws:
com.liferay.portal.kernel.exception.PortalException
-
updateSXPBlueprint
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
-