com.liferay.portal.kernel.service

Interface RememberMeTokenLocalService

All Superinterfaces:

BaseLocalService, PersistedModelLocalService

All Known Implementing Classes:

RememberMeTokenLocalServiceWrapper

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

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

RememberMeTokenLocalServiceUtil

Generated:

Method Summary

Modifier and Type	Method and Description
RememberMeToken	addRememberMeToken(long companyId, long userId, java.util.Date expirationDate, java.util.function.Consumer<java.lang.String> valueConsumer)
RememberMeToken	addRememberMeToken(RememberMeToken rememberMeToken) Adds the remember me token to the database.
PersistedModel	createPersistedModel(java.io.Serializable primaryKeyObj)
RememberMeToken	createRememberMeToken(long rememberMeTokenId) Creates a new remember me token with the primary key.
void	deleteExpiredRememberMeTokens(java.util.Date expirationDate)
void	deleteExpiredRememberMeTokens(long userId)
PersistedModel	deletePersistedModel(PersistedModel persistedModel)
RememberMeToken	deleteRememberMeToken(long rememberMeTokenId) Deletes the remember me token with the primary key from the database.
RememberMeToken	deleteRememberMeToken(RememberMeToken rememberMeToken) Deletes the remember me token from the database.
<T> T	dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)
int	dslQueryCount(com.liferay.petra.sql.dsl.query.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.
RememberMeToken	fetchRememberMeToken(long rememberMeTokenId)
RememberMeToken	fetchRememberMeToken(long rememberMeTokenId, java.lang.String value)
ActionableDynamicQuery	getActionableDynamicQuery()
IndexableActionableDynamicQuery	getIndexableActionableDynamicQuery()
java.lang.String	getOSGiServiceIdentifier() Returns the OSGi service identifier.
PersistedModel	getPersistedModel(java.io.Serializable primaryKeyObj)
RememberMeToken	getRememberMeToken(long rememberMeTokenId) Returns the remember me token with the primary key.
java.util.List<RememberMeToken>	getRememberMeTokens(int start, int end) Returns a range of all the remember me tokens.
int	getRememberMeTokensCount() Returns the number of remember me tokens.
RememberMeToken	updateRememberMeToken(RememberMeToken rememberMeToken) Updates the remember me token in the database or adds it if it does not yet exist.

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

fetchPersistedModel, getBasePersistence

Method Detail

addRememberMeToken

RememberMeToken addRememberMeToken(long companyId,
                                   long userId,
                                   java.util.Date expirationDate,
                                   java.util.function.Consumer<java.lang.String> valueConsumer)
                            throws PwdEncryptorException

Throws:

PwdEncryptorException

addRememberMeToken

@Indexable(type=REINDEX)
RememberMeToken addRememberMeToken(RememberMeToken rememberMeToken)

Adds the remember me token to the database. Also notifies the appropriate model listeners.

Important: Inspect RememberMeTokenLocalServiceImpl 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:

rememberMeToken - the remember me token

Returns:

the remember me token that was added

createPersistedModel

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

Specified by:

createPersistedModel in interface PersistedModelLocalService

Throws:

PortalException

createRememberMeToken

@Transactional(enabled=false)
RememberMeToken createRememberMeToken(long rememberMeTokenId)

Creates a new remember me token with the primary key. Does not add the remember me token to the database.

Parameters:

rememberMeTokenId - the primary key for the new remember me token

Returns:

the new remember me token

deleteExpiredRememberMeTokens

void deleteExpiredRememberMeTokens(java.util.Date expirationDate)

deleteExpiredRememberMeTokens

void deleteExpiredRememberMeTokens(long userId)

deletePersistedModel

PersistedModel deletePersistedModel(PersistedModel persistedModel)
                             throws PortalException

Specified by:

deletePersistedModel in interface PersistedModelLocalService

Throws:

PortalException

deleteRememberMeToken

@Indexable(type=DELETE)
RememberMeToken deleteRememberMeToken(long rememberMeTokenId)
                                                       throws PortalException

Deletes the remember me token with the primary key from the database. Also notifies the appropriate model listeners.

Important: Inspect RememberMeTokenLocalServiceImpl 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:

rememberMeTokenId - the primary key of the remember me token

Returns:

the remember me token that was removed

Throws:

PortalException - if a remember me token with the primary key could not be found

deleteRememberMeToken

@Indexable(type=DELETE)
RememberMeToken deleteRememberMeToken(RememberMeToken rememberMeToken)

Deletes the remember me token from the database. Also notifies the appropriate model listeners.

Important: Inspect RememberMeTokenLocalServiceImpl 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:

rememberMeToken - the remember me token

Returns:

the remember me token that was removed

dslQuery

@Transactional(propagation=SUPPORTS,
               readOnly=true)
<T> T dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)

Specified by:

dslQuery in interface PersistedModelLocalService

dslQueryCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery)

Specified by:

dslQueryCount in interface PersistedModelLocalService

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.portal.model.impl.RememberMeTokenModelImpl.

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.portal.model.impl.RememberMeTokenModelImpl.

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

fetchRememberMeToken

@Transactional(propagation=SUPPORTS,
               readOnly=true)
RememberMeToken fetchRememberMeToken(long rememberMeTokenId)

fetchRememberMeToken

@Transactional(propagation=SUPPORTS,
               readOnly=true)
RememberMeToken fetchRememberMeToken(long rememberMeTokenId,
                                                                                                        java.lang.String value)
                                                                                                 throws PwdEncryptorException

Throws:

PwdEncryptorException

getActionableDynamicQuery

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

getIndexableActionableDynamicQuery

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

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

getRememberMeToken

@Transactional(propagation=SUPPORTS,
               readOnly=true)
RememberMeToken getRememberMeToken(long rememberMeTokenId)
                                                                                               throws PortalException

Returns the remember me token with the primary key.

Parameters:

rememberMeTokenId - the primary key of the remember me token

Returns:

the remember me token

Throws:

PortalException - if a remember me token with the primary key could not be found

getRememberMeTokens

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

Returns a range of all the remember me tokens.

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.portal.model.impl.RememberMeTokenModelImpl.

Parameters:

start - the lower bound of the range of remember me tokens

end - the upper bound of the range of remember me tokens (not inclusive)

Returns:

the range of remember me tokens

getRememberMeTokensCount

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

Returns the number of remember me tokens.

Returns:

the number of remember me tokens

updateRememberMeToken

@Indexable(type=REINDEX)
RememberMeToken updateRememberMeToken(RememberMeToken rememberMeToken)

Updates the remember me token in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

Important: Inspect RememberMeTokenLocalServiceImpl 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:

rememberMeToken - the remember me token

Returns:

the remember me token that was updated