com.liferay.saml.persistence.service.SamlSpMessageLocalServiceUtil Maven / Gradle / Ivy
/**
* SPDX-FileCopyrightText: (c) 2000 Liferay, Inc. https://liferay.com
* SPDX-License-Identifier: LGPL-2.1-or-later OR LicenseRef-Liferay-DXP-EULA-2.0.0-2023-06
*/
package com.liferay.saml.persistence.service;
import com.liferay.petra.sql.dsl.query.DSLQuery;
import com.liferay.portal.kernel.dao.orm.DynamicQuery;
import com.liferay.portal.kernel.exception.PortalException;
import com.liferay.portal.kernel.model.PersistedModel;
import com.liferay.portal.kernel.module.service.Snapshot;
import com.liferay.portal.kernel.util.OrderByComparator;
import com.liferay.saml.persistence.model.SamlSpMessage;
import java.io.Serializable;
import java.util.List;
/**
* Provides the local service utility for SamlSpMessage. This utility wraps
* com.liferay.saml.persistence.service.impl.SamlSpMessageLocalServiceImpl 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.
*
* @author Mika Koivisto
* @see SamlSpMessageLocalService
* @generated
*/
public class SamlSpMessageLocalServiceUtil {
/*
* NOTE FOR DEVELOPERS:
*
* Never modify this class directly. Add custom service methods to com.liferay.saml.persistence.service.impl.SamlSpMessageLocalServiceImpl and rerun ServiceBuilder to regenerate this class.
*/
/**
* Adds the saml sp message to the database. Also notifies the appropriate model listeners.
*
*
* Important: Inspect SamlSpMessageLocalServiceImpl 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.
*
*
* @param samlSpMessage the saml sp message
* @return the saml sp message that was added
*/
public static SamlSpMessage addSamlSpMessage(SamlSpMessage samlSpMessage) {
return getService().addSamlSpMessage(samlSpMessage);
}
public static SamlSpMessage addSamlSpMessage(
String samlIdpEntityId, String samlIdpResponseKey,
java.util.Date expirationDate,
com.liferay.portal.kernel.service.ServiceContext serviceContext) {
return getService().addSamlSpMessage(
samlIdpEntityId, samlIdpResponseKey, expirationDate,
serviceContext);
}
/**
* @throws PortalException
*/
public static PersistedModel createPersistedModel(
Serializable primaryKeyObj)
throws PortalException {
return getService().createPersistedModel(primaryKeyObj);
}
/**
* Creates a new saml sp message with the primary key. Does not add the saml sp message to the database.
*
* @param samlSpMessageId the primary key for the new saml sp message
* @return the new saml sp message
*/
public static SamlSpMessage createSamlSpMessage(long samlSpMessageId) {
return getService().createSamlSpMessage(samlSpMessageId);
}
public static void deleteExpiredSamlSpMessages() {
getService().deleteExpiredSamlSpMessages();
}
/**
* @throws PortalException
*/
public static PersistedModel deletePersistedModel(
PersistedModel persistedModel)
throws PortalException {
return getService().deletePersistedModel(persistedModel);
}
/**
* Deletes the saml sp message with the primary key from the database. Also notifies the appropriate model listeners.
*
*
* Important: Inspect SamlSpMessageLocalServiceImpl 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.
*
*
* @param samlSpMessageId the primary key of the saml sp message
* @return the saml sp message that was removed
* @throws PortalException if a saml sp message with the primary key could not be found
*/
public static SamlSpMessage deleteSamlSpMessage(long samlSpMessageId)
throws PortalException {
return getService().deleteSamlSpMessage(samlSpMessageId);
}
/**
* Deletes the saml sp message from the database. Also notifies the appropriate model listeners.
*
*
* Important: Inspect SamlSpMessageLocalServiceImpl 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.
*
*
* @param samlSpMessage the saml sp message
* @return the saml sp message that was removed
*/
public static SamlSpMessage deleteSamlSpMessage(
SamlSpMessage samlSpMessage) {
return getService().deleteSamlSpMessage(samlSpMessage);
}
public static T dslQuery(DSLQuery dslQuery) {
return getService().dslQuery(dslQuery);
}
public static int dslQueryCount(DSLQuery dslQuery) {
return getService().dslQueryCount(dslQuery);
}
public static DynamicQuery dynamicQuery() {
return getService().dynamicQuery();
}
/**
* Performs a dynamic query on the database and returns the matching rows.
*
* @param dynamicQuery the dynamic query
* @return the matching rows
*/
public static List dynamicQuery(DynamicQuery dynamicQuery) {
return getService().dynamicQuery(dynamicQuery);
}
/**
* 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.saml.persistence.model.impl.SamlSpMessageModelImpl.
*
*
* @param dynamicQuery the dynamic query
* @param start the lower bound of the range of model instances
* @param end the upper bound of the range of model instances (not inclusive)
* @return the range of matching rows
*/
public static List dynamicQuery(
DynamicQuery dynamicQuery, int start, int end) {
return getService().dynamicQuery(dynamicQuery, start, end);
}
/**
* 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.saml.persistence.model.impl.SamlSpMessageModelImpl.
*
*
* @param dynamicQuery the dynamic query
* @param start the lower bound of the range of model instances
* @param end the upper bound of the range of model instances (not inclusive)
* @param orderByComparator the comparator to order the results by (optionally null)
* @return the ordered range of matching rows
*/
public static List dynamicQuery(
DynamicQuery dynamicQuery, int start, int end,
OrderByComparator orderByComparator) {
return getService().dynamicQuery(
dynamicQuery, start, end, orderByComparator);
}
/**
* Returns the number of rows matching the dynamic query.
*
* @param dynamicQuery the dynamic query
* @return the number of rows matching the dynamic query
*/
public static long dynamicQueryCount(DynamicQuery dynamicQuery) {
return getService().dynamicQueryCount(dynamicQuery);
}
/**
* Returns the number of rows matching the dynamic query.
*
* @param dynamicQuery the dynamic query
* @param projection the projection to apply to the query
* @return the number of rows matching the dynamic query
*/
public static long dynamicQueryCount(
DynamicQuery dynamicQuery,
com.liferay.portal.kernel.dao.orm.Projection projection) {
return getService().dynamicQueryCount(dynamicQuery, projection);
}
public static SamlSpMessage fetchSamlSpMessage(long samlSpMessageId) {
return getService().fetchSamlSpMessage(samlSpMessageId);
}
public static SamlSpMessage fetchSamlSpMessage(
String samlIdpEntityId, String samlIdpResponseKey) {
return getService().fetchSamlSpMessage(
samlIdpEntityId, samlIdpResponseKey);
}
public static com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery
getActionableDynamicQuery() {
return getService().getActionableDynamicQuery();
}
public static
com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery
getIndexableActionableDynamicQuery() {
return getService().getIndexableActionableDynamicQuery();
}
/**
* Returns the OSGi service identifier.
*
* @return the OSGi service identifier
*/
public static String getOSGiServiceIdentifier() {
return getService().getOSGiServiceIdentifier();
}
/**
* @throws PortalException
*/
public static PersistedModel getPersistedModel(Serializable primaryKeyObj)
throws PortalException {
return getService().getPersistedModel(primaryKeyObj);
}
/**
* Returns the saml sp message with the primary key.
*
* @param samlSpMessageId the primary key of the saml sp message
* @return the saml sp message
* @throws PortalException if a saml sp message with the primary key could not be found
*/
public static SamlSpMessage getSamlSpMessage(long samlSpMessageId)
throws PortalException {
return getService().getSamlSpMessage(samlSpMessageId);
}
public static SamlSpMessage getSamlSpMessage(
String samlIdpEntityId, String samlIdpResponseKey)
throws PortalException {
return getService().getSamlSpMessage(
samlIdpEntityId, samlIdpResponseKey);
}
/**
* Returns a range of all the saml sp messages.
*
*
* 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.saml.persistence.model.impl.SamlSpMessageModelImpl.
*
*
* @param start the lower bound of the range of saml sp messages
* @param end the upper bound of the range of saml sp messages (not inclusive)
* @return the range of saml sp messages
*/
public static List getSamlSpMessages(int start, int end) {
return getService().getSamlSpMessages(start, end);
}
/**
* Returns the number of saml sp messages.
*
* @return the number of saml sp messages
*/
public static int getSamlSpMessagesCount() {
return getService().getSamlSpMessagesCount();
}
/**
* Updates the saml sp message in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
*
*
* Important: Inspect SamlSpMessageLocalServiceImpl 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.
*
*
* @param samlSpMessage the saml sp message
* @return the saml sp message that was updated
*/
public static SamlSpMessage updateSamlSpMessage(
SamlSpMessage samlSpMessage) {
return getService().updateSamlSpMessage(samlSpMessage);
}
public static SamlSpMessageLocalService getService() {
return _serviceSnapshot.get();
}
private static final Snapshot _serviceSnapshot =
new Snapshot<>(
SamlSpMessageLocalServiceUtil.class,
SamlSpMessageLocalService.class);
}