Class SXPElementLocalServiceUtil
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 Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic SXPElementaddSXPElement(SXPElement sxpElement) Adds the sxp element to the database.static SXPElementaddSXPElement(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) static com.liferay.portal.kernel.model.PersistedModelcreatePersistedModel(Serializable primaryKeyObj) static SXPElementcreateSXPElement(long sxpElementId) Creates a new sxp element with the primary key.static voiddeleteCompanySXPElements(long companyId) static com.liferay.portal.kernel.model.PersistedModeldeletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel) static SXPElementdeleteSXPElement(long sxpElementId) Deletes the sxp element with the primary key from the database.static SXPElementdeleteSXPElement(SXPElement sxpElement) Deletes the sxp element 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 SXPElementfetchSXPElement(long sxpElementId) static SXPElementfetchSXPElementByExternalReferenceCode(String externalReferenceCode, long companyId) static SXPElementfetchSXPElementByUuidAndCompanyId(String uuid, long companyId) Returns the sxp element 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 SXPElementLocalServicestatic SXPElementgetSXPElement(long sxpElementId) Returns the sxp element with the primary key.static SXPElementgetSXPElementByExternalReferenceCode(String externalReferenceCode, long companyId) static SXPElementgetSXPElementByUuidAndCompanyId(String uuid, long companyId) Returns the sxp element with the matching UUID and company.static List<SXPElement> getSXPElements(int start, int end) Returns a range of all the sxp elements.static List<SXPElement> getSXPElements(long companyId, boolean readOnly) static intReturns the number of sxp elements.static SXPElementupdateStatus(long userId, long sxpElementId, int status) static SXPElementupdateSXPElement(SXPElement sxpElement) Updates the sxp element in the database or adds it if it does not yet exist.static SXPElementupdateSXPElement(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)
-
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, throws com.liferay.portal.kernel.exception.PortalExceptionString> titleMap, int type, com.liferay.portal.kernel.service.ServiceContext serviceContext) - Throws:
com.liferay.portal.kernel.exception.PortalException
-
addSXPElement
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
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
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.SXPElementModelImpl.- 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.SXPElementModelImpl.- 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
-
fetchSXPElement
-
fetchSXPElementByExternalReferenceCode
public static SXPElement fetchSXPElementByExternalReferenceCode(String externalReferenceCode, long companyId) -
fetchSXPElementByUuidAndCompanyId
Returns the sxp element with the matching UUID and company.- Parameters:
uuid- the sxp element's UUIDcompanyId- the primary key of the company- Returns:
- the matching sxp element, or
nullif 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
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 UUIDcompanyId- 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
Returns a range of all the sxp elements.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.SXPElementModelImpl.- Parameters:
start- the lower bound of the range of sxp elementsend- the upper bound of the range of sxp elements (not inclusive)- Returns:
- the range of sxp elements
-
getSXPElements
-
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, throws com.liferay.portal.kernel.exception.PortalExceptionString> titleMap, com.liferay.portal.kernel.service.ServiceContext serviceContext) - Throws:
com.liferay.portal.kernel.exception.PortalException
-
updateSXPElement
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
-