com.liferay.saml.persistence.service.SamlPeerBindingLocalService 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.ActionableDynamicQuery;
import com.liferay.portal.kernel.dao.orm.DynamicQuery;
import com.liferay.portal.kernel.dao.orm.IndexableActionableDynamicQuery;
import com.liferay.portal.kernel.dao.orm.Projection;
import com.liferay.portal.kernel.exception.PortalException;
import com.liferay.portal.kernel.exception.SystemException;
import com.liferay.portal.kernel.model.PersistedModel;
import com.liferay.portal.kernel.search.Indexable;
import com.liferay.portal.kernel.search.IndexableType;
import com.liferay.portal.kernel.service.BaseLocalService;
import com.liferay.portal.kernel.service.PersistedModelLocalService;
import com.liferay.portal.kernel.transaction.Isolation;
import com.liferay.portal.kernel.transaction.Propagation;
import com.liferay.portal.kernel.transaction.Transactional;
import com.liferay.portal.kernel.util.OrderByComparator;
import com.liferay.saml.persistence.model.SamlPeerBinding;
import java.io.Serializable;
import java.util.List;
import org.osgi.annotation.versioning.ProviderType;
/**
* Provides the local service interface for SamlPeerBinding. 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 SamlPeerBindingLocalServiceUtil
* @generated
*/
@ProviderType
@Transactional(
isolation = Isolation.PORTAL,
rollbackFor = {PortalException.class, SystemException.class}
)
public interface SamlPeerBindingLocalService
extends BaseLocalService, PersistedModelLocalService {
/*
* NOTE FOR DEVELOPERS:
*
* Never modify this interface directly. Add custom service methods to com.liferay.saml.persistence.service.impl.SamlPeerBindingLocalServiceImpl and rerun ServiceBuilder to automatically copy the method declarations to this interface. Consume the saml peer binding local service via injection or a org.osgi.util.tracker.ServiceTracker. Use {@link SamlPeerBindingLocalServiceUtil} if injection and service tracking are not available.
*/
public SamlPeerBinding addSamlPeerBinding(
long userId, String samlNameIdFormat,
String samlNameIdNameQualifier, String samlNameIdSpNameQualifier,
String samlNameIdSpProvidedId, String samlNameIdValue,
String samlPeerEntityId)
throws PortalException;
/**
* Adds the saml peer binding to the database. Also notifies the appropriate model listeners.
*
*
* Important: Inspect SamlPeerBindingLocalServiceImpl 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 samlPeerBinding the saml peer binding
* @return the saml peer binding that was added
*/
@Indexable(type = IndexableType.REINDEX)
public SamlPeerBinding addSamlPeerBinding(SamlPeerBinding samlPeerBinding);
/**
* @throws PortalException
*/
public PersistedModel createPersistedModel(Serializable primaryKeyObj)
throws PortalException;
/**
* Creates a new saml peer binding with the primary key. Does not add the saml peer binding to the database.
*
* @param samlPeerBindingId the primary key for the new saml peer binding
* @return the new saml peer binding
*/
@Transactional(enabled = false)
public SamlPeerBinding createSamlPeerBinding(long samlPeerBindingId);
/**
* @throws PortalException
*/
@Override
public PersistedModel deletePersistedModel(PersistedModel persistedModel)
throws PortalException;
/**
* Deletes the saml peer binding with the primary key from the database. Also notifies the appropriate model listeners.
*
*
* Important: Inspect SamlPeerBindingLocalServiceImpl 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 samlPeerBindingId the primary key of the saml peer binding
* @return the saml peer binding that was removed
* @throws PortalException if a saml peer binding with the primary key could not be found
*/
@Indexable(type = IndexableType.DELETE)
public SamlPeerBinding deleteSamlPeerBinding(long samlPeerBindingId)
throws PortalException;
/**
* Deletes the saml peer binding from the database. Also notifies the appropriate model listeners.
*
*
* Important: Inspect SamlPeerBindingLocalServiceImpl 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 samlPeerBinding the saml peer binding
* @return the saml peer binding that was removed
*/
@Indexable(type = IndexableType.DELETE)
public SamlPeerBinding deleteSamlPeerBinding(
SamlPeerBinding samlPeerBinding);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public T dslQuery(DSLQuery dslQuery);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public int dslQueryCount(DSLQuery dslQuery);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public DynamicQuery dynamicQuery();
/**
* Performs a dynamic query on the database and returns the matching rows.
*
* @param dynamicQuery the dynamic query
* @return the matching rows
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List dynamicQuery(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.SamlPeerBindingModelImpl.
*
*
* @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
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List dynamicQuery(
DynamicQuery dynamicQuery, int start, int 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.SamlPeerBindingModelImpl.
*
*
* @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
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List dynamicQuery(
DynamicQuery dynamicQuery, int start, int end,
OrderByComparator orderByComparator);
/**
* Returns the number of rows matching the dynamic query.
*
* @param dynamicQuery the dynamic query
* @return the number of rows matching the dynamic query
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public long dynamicQueryCount(DynamicQuery 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
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public long dynamicQueryCount(
DynamicQuery dynamicQuery, Projection projection);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public SamlPeerBinding fetchSamlPeerBinding(long samlPeerBindingId);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public SamlPeerBinding fetchSamlPeerBinding(
long companyId, boolean deleted, String samlNameIdFormat,
String samlNameIdNameQualifier, String samlNameIdValue,
String samlPeerEntityId);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public ActionableDynamicQuery getActionableDynamicQuery();
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public IndexableActionableDynamicQuery getIndexableActionableDynamicQuery();
/**
* Returns the OSGi service identifier.
*
* @return the OSGi service identifier
*/
public String getOSGiServiceIdentifier();
/**
* @throws PortalException
*/
@Override
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public PersistedModel getPersistedModel(Serializable primaryKeyObj)
throws PortalException;
/**
* Returns the saml peer binding with the primary key.
*
* @param samlPeerBindingId the primary key of the saml peer binding
* @return the saml peer binding
* @throws PortalException if a saml peer binding with the primary key could not be found
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public SamlPeerBinding getSamlPeerBinding(long samlPeerBindingId)
throws PortalException;
/**
* Returns a range of all the saml peer bindings.
*
*
* 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.SamlPeerBindingModelImpl.
*
*
* @param start the lower bound of the range of saml peer bindings
* @param end the upper bound of the range of saml peer bindings (not inclusive)
* @return the range of saml peer bindings
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List getSamlPeerBindings(int start, int end);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List getSamlPeerBindings(
long companyId, boolean deleted, String samlNameIdFormat,
String samlNameIdNameQualifier, String samlNameIdValue,
String samlPeerEntityId);
/**
* Returns the number of saml peer bindings.
*
* @return the number of saml peer bindings
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public int getSamlPeerBindingsCount();
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List getUserSamlPeerBindings(
long userId, boolean deleted, String samlNameIdFormat,
String samlNameIdNameQualifier, String samlPeerEntityId)
throws PortalException;
/**
* Updates the saml peer binding in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
*
*
* Important: Inspect SamlPeerBindingLocalServiceImpl 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 samlPeerBinding the saml peer binding
* @return the saml peer binding that was updated
*/
@Indexable(type = IndexableType.REINDEX)
public SamlPeerBinding updateSamlPeerBinding(
SamlPeerBinding samlPeerBinding);
}