com.liferay.saml.persistence.service.SamlIdpSpSessionLocalService Maven / Gradle / Ivy
/**
* Copyright (c) 2000-present Liferay, Inc. All rights reserved.
*
* The contents of this file are subject to the terms of the Liferay Enterprise
* Subscription License ("License"). You may not use this file except in
* compliance with the License. You can obtain a copy of the License by
* contacting Liferay, Inc. See the License for the specific language governing
* permissions and limitations under the License, including but not limited to
* distribution rights of the Software.
*
*
*
*/
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.service.ServiceContext;
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.SamlIdpSpSession;
import java.io.Serializable;
import java.util.List;
import org.osgi.annotation.versioning.ProviderType;
/**
* Provides the local service interface for SamlIdpSpSession. 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 SamlIdpSpSessionLocalServiceUtil
* @generated
*/
@ProviderType
@Transactional(
isolation = Isolation.PORTAL,
rollbackFor = {PortalException.class, SystemException.class}
)
public interface SamlIdpSpSessionLocalService
extends BaseLocalService, PersistedModelLocalService {
/*
* NOTE FOR DEVELOPERS:
*
* Never modify this interface directly. Add custom service methods to com.liferay.saml.persistence.service.impl.SamlIdpSpSessionLocalServiceImpl and rerun ServiceBuilder to automatically copy the method declarations to this interface. Consume the saml idp sp session local service via injection or a org.osgi.util.tracker.ServiceTracker. Use {@link SamlIdpSpSessionLocalServiceUtil} if injection and service tracking are not available.
*/
public SamlIdpSpSession addSamlIdpSpSession(
long samlIdpSsoSessionId, String samlSpEntityId,
String nameIdFormat, String nameIdValue,
ServiceContext serviceContext)
throws PortalException;
/**
* Adds the saml idp sp session to the database. Also notifies the appropriate model listeners.
*
*
* Important: Inspect SamlIdpSpSessionLocalServiceImpl 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 samlIdpSpSession the saml idp sp session
* @return the saml idp sp session that was added
*/
@Indexable(type = IndexableType.REINDEX)
public SamlIdpSpSession addSamlIdpSpSession(
SamlIdpSpSession samlIdpSpSession);
/**
* @throws PortalException
*/
public PersistedModel createPersistedModel(Serializable primaryKeyObj)
throws PortalException;
/**
* Creates a new saml idp sp session with the primary key. Does not add the saml idp sp session to the database.
*
* @param samlIdpSpSessionId the primary key for the new saml idp sp session
* @return the new saml idp sp session
*/
@Transactional(enabled = false)
public SamlIdpSpSession createSamlIdpSpSession(long samlIdpSpSessionId);
/**
* @throws PortalException
*/
@Override
public PersistedModel deletePersistedModel(PersistedModel persistedModel)
throws PortalException;
/**
* Deletes the saml idp sp session with the primary key from the database. Also notifies the appropriate model listeners.
*
*
* Important: Inspect SamlIdpSpSessionLocalServiceImpl 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 samlIdpSpSessionId the primary key of the saml idp sp session
* @return the saml idp sp session that was removed
* @throws PortalException if a saml idp sp session with the primary key could not be found
*/
@Indexable(type = IndexableType.DELETE)
public SamlIdpSpSession deleteSamlIdpSpSession(long samlIdpSpSessionId)
throws PortalException;
/**
* Deletes the saml idp sp session from the database. Also notifies the appropriate model listeners.
*
*
* Important: Inspect SamlIdpSpSessionLocalServiceImpl 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 samlIdpSpSession the saml idp sp session
* @return the saml idp sp session that was removed
*/
@Indexable(type = IndexableType.DELETE)
public SamlIdpSpSession deleteSamlIdpSpSession(
SamlIdpSpSession samlIdpSpSession);
@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.SamlIdpSpSessionModelImpl.
*
*
* @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.SamlIdpSpSessionModelImpl.
*
*
* @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 SamlIdpSpSession fetchSamlIdpSpSession(long samlIdpSpSessionId);
@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 idp sp session with the primary key.
*
* @param samlIdpSpSessionId the primary key of the saml idp sp session
* @return the saml idp sp session
* @throws PortalException if a saml idp sp session with the primary key could not be found
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public SamlIdpSpSession getSamlIdpSpSession(long samlIdpSpSessionId)
throws PortalException;
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public SamlIdpSpSession getSamlIdpSpSession(
long samlIdpSsoSessionId, String samlSpEntityId)
throws PortalException;
/**
* Returns a range of all the saml idp sp sessions.
*
*
* 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.SamlIdpSpSessionModelImpl.
*
*
* @param start the lower bound of the range of saml idp sp sessions
* @param end the upper bound of the range of saml idp sp sessions (not inclusive)
* @return the range of saml idp sp sessions
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List getSamlIdpSpSessions(int start, int end);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List getSamlIdpSpSessions(
long samlIdpSsoSessionId);
/**
* Returns the number of saml idp sp sessions.
*
* @return the number of saml idp sp sessions
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public int getSamlIdpSpSessionsCount();
public SamlIdpSpSession updateModifiedDate(
long samlIdpSsoSessionId, String samlSpEntityId)
throws PortalException;
/**
* Updates the saml idp sp session in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
*
*
* Important: Inspect SamlIdpSpSessionLocalServiceImpl 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 samlIdpSpSession the saml idp sp session
* @return the saml idp sp session that was updated
*/
@Indexable(type = IndexableType.REINDEX)
public SamlIdpSpSession updateSamlIdpSpSession(
SamlIdpSpSession samlIdpSpSession);
}