public class SXPElementLocalServiceUtil
extends java.lang.Object
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.SXPElementLocalService
Constructor and Description |
---|
SXPElementLocalServiceUtil() |
Modifier and Type | Method and Description |
---|---|
static SXPElement |
addSXPElement(long userId,
java.util.Map<java.util.Locale,java.lang.String> descriptionMap,
java.lang.String elementDefinitionJSON,
boolean readOnly,
java.lang.String schemaVersion,
java.util.Map<java.util.Locale,java.lang.String> titleMap,
int type,
com.liferay.portal.kernel.service.ServiceContext serviceContext) |
static SXPElement |
addSXPElement(SXPElement sxpElement)
Adds the sxp element to the database.
|
static com.liferay.portal.kernel.model.PersistedModel |
createPersistedModel(java.io.Serializable primaryKeyObj) |
static SXPElement |
createSXPElement(long sxpElementId)
Creates a new sxp element with the primary key.
|
static void |
deleteCompanySXPElements(long companyId) |
static com.liferay.portal.kernel.model.PersistedModel |
deletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel) |
static SXPElement |
deleteSXPElement(long sxpElementId)
Deletes the sxp element with the primary key from the database.
|
static SXPElement |
deleteSXPElement(SXPElement sxpElement)
Deletes the sxp element from the database.
|
static <T> T |
dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) |
static int |
dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) |
static com.liferay.portal.kernel.dao.orm.DynamicQuery |
dynamicQuery() |
static <T> java.util.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> java.util.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> java.util.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 long |
dynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
Returns the number of rows matching the dynamic query.
|
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.
|
static SXPElement |
fetchSXPElement(long sxpElementId) |
static SXPElement |
fetchSXPElementByExternalReferenceCode(long companyId,
java.lang.String externalReferenceCode)
Returns the sxp element with the matching external reference code and company.
|
static SXPElement |
fetchSXPElementByReferenceCode(long companyId,
java.lang.String externalReferenceCode)
Deprecated.
As of Cavanaugh (7.4.x), replaced by
fetchSXPElementByExternalReferenceCode(long, String) |
static SXPElement |
fetchSXPElementByUuidAndCompanyId(java.lang.String uuid,
long companyId)
Returns the sxp element with the matching UUID and company.
|
static com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery |
getActionableDynamicQuery() |
static com.liferay.portal.kernel.dao.orm.ExportActionableDynamicQuery |
getExportActionableDynamicQuery(com.liferay.exportimport.kernel.lar.PortletDataContext portletDataContext) |
static com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery |
getIndexableActionableDynamicQuery() |
static java.lang.String |
getOSGiServiceIdentifier()
Returns the OSGi service identifier.
|
static com.liferay.portal.kernel.model.PersistedModel |
getPersistedModel(java.io.Serializable primaryKeyObj) |
static SXPElementLocalService |
getService() |
static SXPElement |
getSXPElement(long sxpElementId)
Returns the sxp element with the primary key.
|
static SXPElement |
getSXPElementByExternalReferenceCode(long companyId,
java.lang.String externalReferenceCode)
Returns the sxp element with the matching external reference code and company.
|
static SXPElement |
getSXPElementByUuidAndCompanyId(java.lang.String uuid,
long companyId)
Returns the sxp element with the matching UUID and company.
|
static java.util.List<SXPElement> |
getSXPElements(int start,
int end)
Returns a range of all the sxp elements.
|
static java.util.List<SXPElement> |
getSXPElements(long companyId,
boolean readOnly) |
static int |
getSXPElementsCount()
Returns the number of sxp elements.
|
static SXPElement |
updateStatus(long userId,
long sxpElementId,
int status) |
static SXPElement |
updateSXPElement(long userId,
long sxpElementId,
java.util.Map<java.util.Locale,java.lang.String> descriptionMap,
java.lang.String elementDefinitionJSON,
boolean hidden,
java.lang.String schemaVersion,
java.util.Map<java.util.Locale,java.lang.String> titleMap,
com.liferay.portal.kernel.service.ServiceContext serviceContext) |
static SXPElement |
updateSXPElement(SXPElement sxpElement)
Updates the sxp element in the database or adds it if it does not yet exist.
|
public static SXPElement addSXPElement(long userId, java.util.Map<java.util.Locale,java.lang.String> descriptionMap, java.lang.String elementDefinitionJSON, boolean readOnly, java.lang.String schemaVersion, java.util.Map<java.util.Locale,java.lang.String> titleMap, int type, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalException
public static SXPElement addSXPElement(SXPElement sxpElement)
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.
sxpElement
- the sxp elementpublic static com.liferay.portal.kernel.model.PersistedModel createPersistedModel(java.io.Serializable primaryKeyObj) throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalException
public static SXPElement createSXPElement(long sxpElementId)
sxpElementId
- the primary key for the new sxp elementpublic static void deleteCompanySXPElements(long companyId) throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalException
public static com.liferay.portal.kernel.model.PersistedModel deletePersistedModel(com.liferay.portal.kernel.model.PersistedModel persistedModel) throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalException
public static SXPElement deleteSXPElement(long sxpElementId) throws com.liferay.portal.kernel.exception.PortalException
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.
sxpElementId
- the primary key of the sxp elementcom.liferay.portal.kernel.exception.PortalException
- if a sxp element with the primary key could not be foundpublic static SXPElement deleteSXPElement(SXPElement sxpElement) throws com.liferay.portal.kernel.exception.PortalException
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.
sxpElement
- the sxp elementcom.liferay.portal.kernel.exception.PortalException
public static <T> T dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)
public static int dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)
public static com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery()
public static <T> java.util.List<T> dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
dynamicQuery
- the dynamic querypublic static <T> java.util.List<T> dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, int end)
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
.
dynamicQuery
- the dynamic querystart
- the lower bound of the range of model instancesend
- the upper bound of the range of model instances (not inclusive)public static <T> java.util.List<T> dynamicQuery(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, int start, int end, com.liferay.portal.kernel.util.OrderByComparator<T> orderByComparator)
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
.
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 (optionally null
)public static long dynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery)
dynamicQuery
- the dynamic querypublic static long dynamicQueryCount(com.liferay.portal.kernel.dao.orm.DynamicQuery dynamicQuery, com.liferay.portal.kernel.dao.orm.Projection projection)
dynamicQuery
- the dynamic queryprojection
- the projection to apply to the querypublic static SXPElement fetchSXPElement(long sxpElementId)
public static SXPElement fetchSXPElementByExternalReferenceCode(long companyId, java.lang.String externalReferenceCode)
companyId
- the primary key of the companyexternalReferenceCode
- the sxp element's external reference codenull
if a matching sxp element could not be found@Deprecated public static SXPElement fetchSXPElementByReferenceCode(long companyId, java.lang.String externalReferenceCode)
fetchSXPElementByExternalReferenceCode(long, String)
public static SXPElement fetchSXPElementByUuidAndCompanyId(java.lang.String uuid, long companyId)
uuid
- the sxp element's UUIDcompanyId
- the primary key of the companynull
if a matching sxp element could not be foundpublic static com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery getActionableDynamicQuery()
public static com.liferay.portal.kernel.dao.orm.ExportActionableDynamicQuery getExportActionableDynamicQuery(com.liferay.exportimport.kernel.lar.PortletDataContext portletDataContext)
public static com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()
public static java.lang.String getOSGiServiceIdentifier()
public static com.liferay.portal.kernel.model.PersistedModel getPersistedModel(java.io.Serializable primaryKeyObj) throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalException
public static SXPElement getSXPElement(long sxpElementId) throws com.liferay.portal.kernel.exception.PortalException
sxpElementId
- the primary key of the sxp elementcom.liferay.portal.kernel.exception.PortalException
- if a sxp element with the primary key could not be foundpublic static SXPElement getSXPElementByExternalReferenceCode(long companyId, java.lang.String externalReferenceCode) throws com.liferay.portal.kernel.exception.PortalException
companyId
- the primary key of the companyexternalReferenceCode
- the sxp element's external reference codecom.liferay.portal.kernel.exception.PortalException
- if a matching sxp element could not be foundpublic static SXPElement getSXPElementByUuidAndCompanyId(java.lang.String uuid, long companyId) throws com.liferay.portal.kernel.exception.PortalException
uuid
- the sxp element's UUIDcompanyId
- the primary key of the companycom.liferay.portal.kernel.exception.PortalException
- if a matching sxp element could not be foundpublic static java.util.List<SXPElement> getSXPElements(int start, int end)
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
.
start
- the lower bound of the range of sxp elementsend
- the upper bound of the range of sxp elements (not inclusive)public static java.util.List<SXPElement> getSXPElements(long companyId, boolean readOnly)
public static int getSXPElementsCount()
public static SXPElement updateStatus(long userId, long sxpElementId, int status) throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalException
public static SXPElement updateSXPElement(long userId, long sxpElementId, java.util.Map<java.util.Locale,java.lang.String> descriptionMap, java.lang.String elementDefinitionJSON, boolean hidden, java.lang.String schemaVersion, java.util.Map<java.util.Locale,java.lang.String> titleMap, com.liferay.portal.kernel.service.ServiceContext serviceContext) throws com.liferay.portal.kernel.exception.PortalException
com.liferay.portal.kernel.exception.PortalException
public static SXPElement updateSXPElement(SXPElement sxpElement)
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.
sxpElement
- the sxp elementpublic static SXPElementLocalService getService()