com.liferay.oauth2.provider.service.OAuth2ScopeGrantLocalService Maven / Gradle / Ivy
/**
* Copyright (c) 2000-present Liferay, Inc. All rights reserved.
*
* This library is free software; you can redistribute it and/or modify it under
* the terms of the GNU Lesser General Public License as published by the Free
* Software Foundation; either version 2.1 of the License, or (at your option)
* any later version.
*
* This library is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
* FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
* details.
*/
package com.liferay.oauth2.provider.service;
import aQute.bnd.annotation.ProviderType;
import com.liferay.oauth2.provider.exception.DuplicateOAuth2ScopeGrantException;
import com.liferay.oauth2.provider.model.OAuth2ScopeGrant;
import com.liferay.oauth2.provider.scope.liferay.LiferayOAuth2Scope;
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 java.io.Serializable;
import java.util.Collection;
import java.util.List;
/**
* Provides the local service interface for OAuth2ScopeGrant. 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 Brian Wing Shun Chan
* @see OAuth2ScopeGrantLocalServiceUtil
* @generated
*/
@ProviderType
@Transactional(
isolation = Isolation.PORTAL,
rollbackFor = {PortalException.class, SystemException.class}
)
public interface OAuth2ScopeGrantLocalService
extends BaseLocalService, PersistedModelLocalService {
/*
* NOTE FOR DEVELOPERS:
*
* Never modify or reference this interface directly. Always use {@link OAuth2ScopeGrantLocalServiceUtil} to access the o auth2 scope grant local service. Add custom service methods to com.liferay.oauth2.provider.service.impl.OAuth2ScopeGrantLocalServiceImpl and rerun ServiceBuilder to automatically copy the method declarations to this interface.
*/
public void addOAuth2AuthorizationOAuth2ScopeGrant(
long oAuth2AuthorizationId, long oAuth2ScopeGrantId);
public void addOAuth2AuthorizationOAuth2ScopeGrant(
long oAuth2AuthorizationId, OAuth2ScopeGrant oAuth2ScopeGrant);
public void addOAuth2AuthorizationOAuth2ScopeGrants(
long oAuth2AuthorizationId, List oAuth2ScopeGrants);
public void addOAuth2AuthorizationOAuth2ScopeGrants(
long oAuth2AuthorizationId, long[] oAuth2ScopeGrantIds);
/**
* Adds the o auth2 scope grant to the database. Also notifies the appropriate model listeners.
*
* @param oAuth2ScopeGrant the o auth2 scope grant
* @return the o auth2 scope grant that was added
*/
@Indexable(type = IndexableType.REINDEX)
public OAuth2ScopeGrant addOAuth2ScopeGrant(
OAuth2ScopeGrant oAuth2ScopeGrant);
public void clearOAuth2AuthorizationOAuth2ScopeGrants(
long oAuth2AuthorizationId);
/**
* Creates a new o auth2 scope grant with the primary key. Does not add the o auth2 scope grant to the database.
*
* @param oAuth2ScopeGrantId the primary key for the new o auth2 scope grant
* @return the new o auth2 scope grant
*/
@Transactional(enabled = false)
public OAuth2ScopeGrant createOAuth2ScopeGrant(long oAuth2ScopeGrantId);
public OAuth2ScopeGrant createOAuth2ScopeGrant(
long companyId, long oAuth2ApplicationScopeAliasesId,
String applicationName, String bundleSymbolicName, String scope)
throws DuplicateOAuth2ScopeGrantException;
public void deleteOAuth2AuthorizationOAuth2ScopeGrant(
long oAuth2AuthorizationId, long oAuth2ScopeGrantId);
public void deleteOAuth2AuthorizationOAuth2ScopeGrant(
long oAuth2AuthorizationId, OAuth2ScopeGrant oAuth2ScopeGrant);
public void deleteOAuth2AuthorizationOAuth2ScopeGrants(
long oAuth2AuthorizationId, List oAuth2ScopeGrants);
public void deleteOAuth2AuthorizationOAuth2ScopeGrants(
long oAuth2AuthorizationId, long[] oAuth2ScopeGrantIds);
/**
* Deletes the o auth2 scope grant with the primary key from the database. Also notifies the appropriate model listeners.
*
* @param oAuth2ScopeGrantId the primary key of the o auth2 scope grant
* @return the o auth2 scope grant that was removed
* @throws PortalException if a o auth2 scope grant with the primary key could not be found
*/
@Indexable(type = IndexableType.DELETE)
public OAuth2ScopeGrant deleteOAuth2ScopeGrant(long oAuth2ScopeGrantId)
throws PortalException;
/**
* Deletes the o auth2 scope grant from the database. Also notifies the appropriate model listeners.
*
* @param oAuth2ScopeGrant the o auth2 scope grant
* @return the o auth2 scope grant that was removed
*/
@Indexable(type = IndexableType.DELETE)
public OAuth2ScopeGrant deleteOAuth2ScopeGrant(
OAuth2ScopeGrant oAuth2ScopeGrant);
/**
* @throws PortalException
*/
@Override
public PersistedModel deletePersistedModel(PersistedModel persistedModel)
throws PortalException;
@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 and pagination is required (start and end are not com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS), then the query will include the default ORDER BY logic from com.liferay.oauth2.provider.model.impl.OAuth2ScopeGrantModelImpl. If both orderByComparator and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.
*
*
* @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 and pagination is required (start and end are not com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS), then the query will include the default ORDER BY logic from com.liferay.oauth2.provider.model.impl.OAuth2ScopeGrantModelImpl. If both orderByComparator and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.
*
*
* @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 OAuth2ScopeGrant fetchOAuth2ScopeGrant(long oAuth2ScopeGrantId);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public ActionableDynamicQuery getActionableDynamicQuery();
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public Collection getFilteredLiferayOAuth2Scopes(
long oAuth2ApplicationScopeAliasesId,
Collection liferayOAuth2Scopes);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public IndexableActionableDynamicQuery getIndexableActionableDynamicQuery();
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List getOAuth2AuthorizationOAuth2ScopeGrants(
long oAuth2AuthorizationId);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List getOAuth2AuthorizationOAuth2ScopeGrants(
long oAuth2AuthorizationId, int start, int end);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List getOAuth2AuthorizationOAuth2ScopeGrants(
long oAuth2AuthorizationId, int start, int end,
OrderByComparator orderByComparator);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public int getOAuth2AuthorizationOAuth2ScopeGrantsCount(
long oAuth2AuthorizationId);
/**
* Returns the oAuth2AuthorizationIds of the o auth2 authorizations associated with the o auth2 scope grant.
*
* @param oAuth2ScopeGrantId the oAuth2ScopeGrantId of the o auth2 scope grant
* @return long[] the oAuth2AuthorizationIds of o auth2 authorizations associated with the o auth2 scope grant
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public long[] getOAuth2AuthorizationPrimaryKeys(long oAuth2ScopeGrantId);
/**
* Returns the o auth2 scope grant with the primary key.
*
* @param oAuth2ScopeGrantId the primary key of the o auth2 scope grant
* @return the o auth2 scope grant
* @throws PortalException if a o auth2 scope grant with the primary key could not be found
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public OAuth2ScopeGrant getOAuth2ScopeGrant(long oAuth2ScopeGrantId)
throws PortalException;
/**
* Returns a range of all the o auth2 scope grants.
*
*
* 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 and pagination is required (start and end are not com.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS), then the query will include the default ORDER BY logic from com.liferay.oauth2.provider.model.impl.OAuth2ScopeGrantModelImpl. If both orderByComparator and pagination are absent, for performance reasons, the query will not have an ORDER BY clause and the returned result set will be sorted on by the primary key in an ascending order.
*
*
* @param start the lower bound of the range of o auth2 scope grants
* @param end the upper bound of the range of o auth2 scope grants (not inclusive)
* @return the range of o auth2 scope grants
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public List getOAuth2ScopeGrants(int start, int end);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public Collection getOAuth2ScopeGrants(
long oAuth2ApplicationScopeAliasesId, int start, int end,
OrderByComparator orderByComparator);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public Collection getOAuth2ScopeGrants(
long companyId, String applicationName, String bundleSymbolicName,
String accessTokenContent);
/**
* Returns the number of o auth2 scope grants.
*
* @return the number of o auth2 scope grants
*/
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public int getOAuth2ScopeGrantsCount();
/**
* Returns the OSGi service identifier.
*
* @return the OSGi service identifier
*/
public String getOSGiServiceIdentifier();
@Override
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public PersistedModel getPersistedModel(Serializable primaryKeyObj)
throws PortalException;
public Collection grantLiferayOAuth2Scopes(
long oAuth2AuthorizationId,
Collection liferayOAuth2Scopes)
throws PortalException;
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public boolean hasOAuth2AuthorizationOAuth2ScopeGrant(
long oAuth2AuthorizationId, long oAuth2ScopeGrantId);
@Transactional(propagation = Propagation.SUPPORTS, readOnly = true)
public boolean hasOAuth2AuthorizationOAuth2ScopeGrants(
long oAuth2AuthorizationId);
public void setOAuth2AuthorizationOAuth2ScopeGrants(
long oAuth2AuthorizationId, long[] oAuth2ScopeGrantIds);
/**
* Updates the o auth2 scope grant in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.
*
* @param oAuth2ScopeGrant the o auth2 scope grant
* @return the o auth2 scope grant that was updated
*/
@Indexable(type = IndexableType.REINDEX)
public OAuth2ScopeGrant updateOAuth2ScopeGrant(
OAuth2ScopeGrant oAuth2ScopeGrant);
}