com.liferay.oauth.service

Interface OAuthUserLocalService

All Superinterfaces:

BaseLocalService, PersistedModelLocalService

All Known Implementing Classes:

OAuthUserLocalServiceWrapper

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

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

OAuthUserLocalServiceUtil

Method Summary

Modifier and Type	Method and Description
OAuthUser	addOAuthUser(long userId, long oAuthApplicationId, java.lang.String accessToken, java.lang.String accessSecret, ServiceContext serviceContext)
OAuthUser	addOAuthUser(OAuthUser oAuthUser) Adds the o auth user to the database.
OAuthUser	createOAuthUser(long oAuthUserId) Creates a new o auth user with the primary key.
PersistedModel	createPersistedModel(java.io.Serializable primaryKeyObj)
OAuthUser	deleteOAuthUser(long oAuthUserId) Deletes the o auth user with the primary key from the database.
OAuthUser	deleteOAuthUser(long userId, long oAuthApplicationId)
OAuthUser	deleteOAuthUser(OAuthUser oAuthUser) Deletes the o auth user 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.
OAuthUser	fetchOAuthUser(long oAuthUserId)
OAuthUser	fetchOAuthUser(long userId, long oAuthApplicationId)
OAuthUser	fetchOAuthUser(java.lang.String accessToken)
ActionableDynamicQuery	getActionableDynamicQuery()
IndexableActionableDynamicQuery	getIndexableActionableDynamicQuery()
java.util.List<OAuthUser>	getOAuthApplicationOAuthUsers(long oAuthApplicationId, int start, int end, OrderByComparator<OAuthUser> orderByComparator)
int	getOAuthApplicationOAuthUsersCount(long oAuthApplicationId)
OAuthUser	getOAuthUser(long oAuthUserId) Returns the o auth user with the primary key.
OAuthUser	getOAuthUser(long userId, long oAuthApplicationId)
OAuthUser	getOAuthUser(java.lang.String accessToken)
java.util.List<OAuthUser>	getOAuthUsers(int start, int end) Returns a range of all the o auth users.
int	getOAuthUsersCount() Returns the number of o auth users.
java.lang.String	getOSGiServiceIdentifier() Returns the OSGi service identifier.
PersistedModel	getPersistedModel(java.io.Serializable primaryKeyObj)
java.util.List<OAuthUser>	getUserOAuthUsers(long userId, int start, int end, OrderByComparator<OAuthUser> orderByComparator)
int	getUserOAuthUsersCount(long userId)
OAuthUser	updateOAuthUser(long userId, long oAuthApplicationId, java.lang.String accessToken, java.lang.String accessSecret, ServiceContext serviceContext)
OAuthUser	updateOAuthUser(OAuthUser oAuthUser) Updates the o auth user 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

addOAuthUser

OAuthUser addOAuthUser(long userId,
                       long oAuthApplicationId,
                       java.lang.String accessToken,
                       java.lang.String accessSecret,
                       ServiceContext serviceContext)
                throws PortalException

Throws:

PortalException

addOAuthUser

@Indexable(type=REINDEX)
OAuthUser addOAuthUser(OAuthUser oAuthUser)

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

Parameters:

oAuthUser - the o auth user

Returns:

the o auth user that was added

createOAuthUser

@Transactional(enabled=false)
OAuthUser createOAuthUser(long oAuthUserId)

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

Parameters:

oAuthUserId - the primary key for the new o auth user

Returns:

the new o auth user

createPersistedModel

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

Specified by:

createPersistedModel in interface PersistedModelLocalService

Throws:

PortalException

deleteOAuthUser

@Indexable(type=DELETE)
OAuthUser deleteOAuthUser(long oAuthUserId)
                                           throws PortalException

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

Parameters:

oAuthUserId - the primary key of the o auth user

Returns:

the o auth user that was removed

Throws:

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

deleteOAuthUser

OAuthUser deleteOAuthUser(long userId,
                          long oAuthApplicationId)
                   throws PortalException

Throws:

PortalException

deleteOAuthUser

@Indexable(type=DELETE)
OAuthUser deleteOAuthUser(OAuthUser oAuthUser)
                                           throws PortalException

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

Parameters:

oAuthUser - the o auth user

Returns:

the o auth user 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.OAuthUserModelImpl.

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.OAuthUserModelImpl.

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

fetchOAuthUser

@Transactional(propagation=SUPPORTS,
               readOnly=true)
OAuthUser fetchOAuthUser(long oAuthUserId)

fetchOAuthUser

@Transactional(propagation=SUPPORTS,
               readOnly=true)
OAuthUser fetchOAuthUser(long userId,
                                                                                            long oAuthApplicationId)

fetchOAuthUser

@Transactional(propagation=SUPPORTS,
               readOnly=true)
OAuthUser fetchOAuthUser(java.lang.String accessToken)

getActionableDynamicQuery

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

getIndexableActionableDynamicQuery

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

getOAuthApplicationOAuthUsers

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<OAuthUser> getOAuthApplicationOAuthUsers(long oAuthApplicationId,
                                                                                                                           int start,
                                                                                                                           int end,
                                                                                                                           OrderByComparator<OAuthUser> orderByComparator)

getOAuthApplicationOAuthUsersCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getOAuthApplicationOAuthUsersCount(long oAuthApplicationId)

getOAuthUser

@Transactional(propagation=SUPPORTS,
               readOnly=true)
OAuthUser getOAuthUser(long oAuthUserId)
                                                                                   throws PortalException

Returns the o auth user with the primary key.

Parameters:

oAuthUserId - the primary key of the o auth user

Returns:

the o auth user

Throws:

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

getOAuthUser

@Transactional(propagation=SUPPORTS,
               readOnly=true)
OAuthUser getOAuthUser(long userId,
                                                                                          long oAuthApplicationId)
                                                                                   throws PortalException

Throws:

PortalException

getOAuthUser

@Transactional(propagation=SUPPORTS,
               readOnly=true)
OAuthUser getOAuthUser(java.lang.String accessToken)
                                                                                   throws PortalException

Throws:

PortalException

getOAuthUsers

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

Returns a range of all the o auth users.

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.OAuthUserModelImpl.

Parameters:

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

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

Returns:

the range of o auth users

getOAuthUsersCount

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

Returns the number of o auth users.

Returns:

the number of o auth users

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

getUserOAuthUsers

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<OAuthUser> getUserOAuthUsers(long userId,
                                                                                                               int start,
                                                                                                               int end,
                                                                                                               OrderByComparator<OAuthUser> orderByComparator)

getUserOAuthUsersCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getUserOAuthUsersCount(long userId)

updateOAuthUser

OAuthUser updateOAuthUser(long userId,
                          long oAuthApplicationId,
                          java.lang.String accessToken,
                          java.lang.String accessSecret,
                          ServiceContext serviceContext)
                   throws PortalException

Throws:

PortalException

updateOAuthUser

@Indexable(type=REINDEX)
OAuthUser updateOAuthUser(OAuthUser oAuthUser)

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

Parameters:

oAuthUser - the o auth user

Returns:

the o auth user that was updated