com.liferay.oauth.service

Interface OAuthApplicationLocalService

All Superinterfaces:

BaseLocalService, PersistedModelLocalService

All Known Implementing Classes:

OAuthApplicationLocalServiceWrapper

@ProviderType
 @Transactional(isolation=PORTAL,
               rollbackFor={PortalException.class,SystemException.class})
public interface OAuthApplicationLocalService
extends BaseLocalService, PersistedModelLocalService

Provides the local service interface for OAuthApplication. 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.

See Also:

OAuthApplicationLocalServiceUtil

Method Summary

Modifier and Type	Method and Description
OAuthApplication	addOAuthApplication(long userId, java.lang.String name, java.lang.String description, int accessLevel, boolean shareableAccessToken, java.lang.String callbackURI, java.lang.String websiteURL, ServiceContext serviceContext) Deprecated. As of Athanasius (7.3.x), replaced by #addOAuthApplication(long, String, String, String, int boolean, String, String, ServiceContext)
OAuthApplication	addOAuthApplication(long userId, java.lang.String name, java.lang.String description, java.lang.String token, int accessLevel, boolean shareableAccessToken, java.lang.String callbackURI, java.lang.String websiteURL, ServiceContext serviceContext)
OAuthApplication	addOAuthApplication(OAuthApplication oAuthApplication) Adds the o auth application to the database.
OAuthApplication	createOAuthApplication(long oAuthApplicationId) Creates a new o auth application with the primary key.
PersistedModel	createPersistedModel(java.io.Serializable primaryKeyObj)
void	deleteLogo(long oAuthApplicationId)
OAuthApplication	deleteOAuthApplication(long oAuthApplicationId) Deletes the o auth application with the primary key from the database.
OAuthApplication	deleteOAuthApplication(OAuthApplication oAuthApplication) Deletes the o auth application from the database.
PersistedModel	deletePersistedModel(PersistedModel persistedModel)
<T> T	dslQuery(DSLQuery dslQuery)
DynamicQuery	dynamicQuery()
<T> java.util.List<T>	dynamicQuery(DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.
<T> java.util.List<T>	dynamicQuery(DynamicQuery dynamicQuery, int start, int end) Performs a dynamic query on the database and returns a range of the matching rows.
<T> java.util.List<T>	dynamicQuery(DynamicQuery dynamicQuery, int start, int end, OrderByComparator<T> orderByComparator) Performs a dynamic query on the database and returns an ordered range of the matching rows.
long	dynamicQueryCount(DynamicQuery dynamicQuery) Returns the number of rows matching the dynamic query.
long	dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection) Returns the number of rows matching the dynamic query.
OAuthApplication	fetchOAuthApplication(long oAuthApplicationId)
OAuthApplication	fetchOAuthApplication(java.lang.String consumerKey)
ActionableDynamicQuery	getActionableDynamicQuery()
IndexableActionableDynamicQuery	getIndexableActionableDynamicQuery()
OAuthApplication	getOAuthApplication(long oAuthApplicationId) Returns the o auth application with the primary key.
OAuthApplication	getOAuthApplication(java.lang.String consumerKey)
java.util.List<OAuthApplication>	getOAuthApplications(int start, int end) Returns a range of all the o auth applications.
java.util.List<OAuthApplication>	getOAuthApplications(long companyId, int start, int end, OrderByComparator<OAuthApplication> orderByComparator)
int	getOAuthApplicationsCount() Returns the number of o auth applications.
int	getOAuthApplicationsCount(long companyId)
java.lang.String	getOSGiServiceIdentifier() Returns the OSGi service identifier.
PersistedModel	getPersistedModel(java.io.Serializable primaryKeyObj)
java.util.List<OAuthApplication>	search(long companyId, java.lang.String keywords, java.util.LinkedHashMap<java.lang.String,java.lang.Object> params, int start, int end, OrderByComparator<OAuthApplication> orderByComparator)
int	searchCount(long companyId, java.lang.String keywords, java.util.LinkedHashMap<java.lang.String,java.lang.Object> params)
OAuthApplication	updateLogo(long oAuthApplicationId, java.io.InputStream inputStream)
OAuthApplication	updateOAuthApplication(long oAuthApplicationId, java.lang.String name, java.lang.String description, boolean shareableAccessToken, java.lang.String callbackURI, java.lang.String websiteURL, ServiceContext serviceContext)
OAuthApplication	updateOAuthApplication(OAuthApplication oAuthApplication) Updates the o auth application in the database or adds it if it does not yet exist.

Methods inherited from interface com.liferay.portal.kernel.service.PersistedModelLocalService

getBasePersistence

Method Detail

addOAuthApplication

@Deprecated
OAuthApplication addOAuthApplication(long userId,
                                                 java.lang.String name,
                                                 java.lang.String description,
                                                 int accessLevel,
                                                 boolean shareableAccessToken,
                                                 java.lang.String callbackURI,
                                                 java.lang.String websiteURL,
                                                 ServiceContext serviceContext)
                                          throws PortalException

Deprecated. As of Athanasius (7.3.x), replaced by #addOAuthApplication(long, String, String, String, int boolean, String, String, ServiceContext)

Throws:

PortalException

addOAuthApplication

OAuthApplication addOAuthApplication(long userId,
                                     java.lang.String name,
                                     java.lang.String description,
                                     java.lang.String token,
                                     int accessLevel,
                                     boolean shareableAccessToken,
                                     java.lang.String callbackURI,
                                     java.lang.String websiteURL,
                                     ServiceContext serviceContext)
                              throws PortalException

Throws:

PortalException

addOAuthApplication

@Indexable(type=REINDEX)
OAuthApplication addOAuthApplication(OAuthApplication oAuthApplication)

Adds the o auth application to the database. Also notifies the appropriate model listeners.

Important: Inspect OAuthApplicationLocalServiceImpl 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.

Parameters:

oAuthApplication - the o auth application

Returns:

the o auth application that was added

createOAuthApplication

@Transactional(enabled=false)
OAuthApplication createOAuthApplication(long oAuthApplicationId)

Creates a new o auth application with the primary key. Does not add the o auth application to the database.

Parameters:

oAuthApplicationId - the primary key for the new o auth application

Returns:

the new o auth application

createPersistedModel

PersistedModel createPersistedModel(java.io.Serializable primaryKeyObj)
                             throws PortalException

Specified by:

createPersistedModel in interface PersistedModelLocalService

Throws:

PortalException

deleteLogo

void deleteLogo(long oAuthApplicationId)
         throws PortalException

Throws:

PortalException

deleteOAuthApplication

@Indexable(type=DELETE)
OAuthApplication deleteOAuthApplication(long oAuthApplicationId)
                                                         throws PortalException

Deletes the o auth application with the primary key from the database. Also notifies the appropriate model listeners.

Important: Inspect OAuthApplicationLocalServiceImpl 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.

Parameters:

oAuthApplicationId - the primary key of the o auth application

Returns:

the o auth application that was removed

Throws:

PortalException - if a o auth application with the primary key could not be found

deleteOAuthApplication

@Indexable(type=DELETE)
OAuthApplication deleteOAuthApplication(OAuthApplication oAuthApplication)
                                                         throws PortalException

Deletes the o auth application from the database. Also notifies the appropriate model listeners.

Important: Inspect OAuthApplicationLocalServiceImpl 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.

Parameters:

oAuthApplication - the o auth application

Returns:

the o auth application that was removed

Throws:

PortalException

deletePersistedModel

PersistedModel deletePersistedModel(PersistedModel persistedModel)
                             throws PortalException

Specified by:

deletePersistedModel in interface PersistedModelLocalService

Throws:

PortalException

dslQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
<T> T dslQuery(DSLQuery dslQuery)

dynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
DynamicQuery dynamicQuery()

dynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
<T> java.util.List<T> dynamicQuery(DynamicQuery dynamicQuery)

Performs a dynamic query on the database and returns the matching rows.

Parameters:

dynamicQuery - the dynamic query

Returns:

the matching rows

dynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
<T> java.util.List<T> dynamicQuery(DynamicQuery dynamicQuery,
                                                                                                      int start,
                                                                                                      int end)

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.oauth.model.impl.OAuthApplicationModelImpl.

Parameters:

dynamicQuery - the dynamic query

start - the lower bound of the range of model instances

end - the upper bound of the range of model instances (not inclusive)

Returns:

the range of matching rows

dynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
<T> java.util.List<T> dynamicQuery(DynamicQuery dynamicQuery,
                                                                                                      int start,
                                                                                                      int end,
                                                                                                      OrderByComparator<T> orderByComparator)

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.oauth.model.impl.OAuthApplicationModelImpl.

Parameters:

dynamicQuery - the dynamic query

start - the lower bound of the range of model instances

end - the upper bound of the range of model instances (not inclusive)

orderByComparator - the comparator to order the results by (optionally null)

Returns:

the ordered range of matching rows

dynamicQueryCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
long dynamicQueryCount(DynamicQuery dynamicQuery)

Returns the number of rows matching the dynamic query.

Parameters:

dynamicQuery - the dynamic query

Returns:

the number of rows matching the dynamic query

dynamicQueryCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
long dynamicQueryCount(DynamicQuery dynamicQuery,
                                                                                          Projection projection)

Returns the number of rows matching the dynamic query.

Parameters:

dynamicQuery - the dynamic query

projection - the projection to apply to the query

Returns:

the number of rows matching the dynamic query

fetchOAuthApplication

@Transactional(propagation=SUPPORTS,
               readOnly=true)
OAuthApplication fetchOAuthApplication(long oAuthApplicationId)

fetchOAuthApplication

@Transactional(propagation=SUPPORTS,
               readOnly=true)
OAuthApplication fetchOAuthApplication(java.lang.String consumerKey)

getActionableDynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
ActionableDynamicQuery getActionableDynamicQuery()

getIndexableActionableDynamicQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
IndexableActionableDynamicQuery getIndexableActionableDynamicQuery()

getOAuthApplication

@Transactional(propagation=SUPPORTS,
               readOnly=true)
OAuthApplication getOAuthApplication(long oAuthApplicationId)
                                                                                                 throws PortalException

Returns the o auth application with the primary key.

Parameters:

oAuthApplicationId - the primary key of the o auth application

Returns:

the o auth application

Throws:

PortalException - if a o auth application with the primary key could not be found

getOAuthApplication

@Transactional(propagation=SUPPORTS,
               readOnly=true)
OAuthApplication getOAuthApplication(java.lang.String consumerKey)
                                                                                                 throws PortalException

Throws:

PortalException

getOAuthApplications

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<OAuthApplication> getOAuthApplications(int start,
                                                                                                                         int end)

Returns a range of all the o auth applications.

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.oauth.model.impl.OAuthApplicationModelImpl.

Parameters:

start - the lower bound of the range of o auth applications

end - the upper bound of the range of o auth applications (not inclusive)

Returns:

the range of o auth applications

getOAuthApplications

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<OAuthApplication> getOAuthApplications(long companyId,
                                                                                                                         int start,
                                                                                                                         int end,
                                                                                                                         OrderByComparator<OAuthApplication> orderByComparator)

getOAuthApplicationsCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getOAuthApplicationsCount()

Returns the number of o auth applications.

Returns:

the number of o auth applications

getOAuthApplicationsCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getOAuthApplicationsCount(long companyId)

getOSGiServiceIdentifier

java.lang.String getOSGiServiceIdentifier()

Returns the OSGi service identifier.

Returns:

the OSGi service identifier

getPersistedModel

@Transactional(propagation=SUPPORTS,
               readOnly=true)
PersistedModel getPersistedModel(java.io.Serializable primaryKeyObj)
                                                                                             throws PortalException

Specified by:

getPersistedModel in interface PersistedModelLocalService

Throws:

PortalException

search

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<OAuthApplication> search(long companyId,
                                                                                                           java.lang.String keywords,
                                                                                                           java.util.LinkedHashMap<java.lang.String,java.lang.Object> params,
                                                                                                           int start,
                                                                                                           int end,
                                                                                                           OrderByComparator<OAuthApplication> orderByComparator)

searchCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int searchCount(long companyId,
                                                                                   java.lang.String keywords,
                                                                                   java.util.LinkedHashMap<java.lang.String,java.lang.Object> params)

updateLogo

OAuthApplication updateLogo(long oAuthApplicationId,
                            java.io.InputStream inputStream)
                     throws PortalException

Throws:

PortalException

updateOAuthApplication

OAuthApplication updateOAuthApplication(long oAuthApplicationId,
                                        java.lang.String name,
                                        java.lang.String description,
                                        boolean shareableAccessToken,
                                        java.lang.String callbackURI,
                                        java.lang.String websiteURL,
                                        ServiceContext serviceContext)
                                 throws PortalException

Throws:

PortalException

updateOAuthApplication

@Indexable(type=REINDEX)
OAuthApplication updateOAuthApplication(OAuthApplication oAuthApplication)

Updates the o auth application in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

Important: Inspect OAuthApplicationLocalServiceImpl 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.

Parameters:

oAuthApplication - the o auth application

Returns:

the o auth application that was updated