Interface RememberMeTokenLocalService
- All Superinterfaces:
BaseLocalService
,PersistedModelLocalService
- All Known Implementing Classes:
RememberMeTokenLocalServiceWrapper
- Author:
- Brian Wing Shun Chan
- See Also:
- {$generated.description}
-
Method Summary
Modifier and TypeMethodDescriptionaddRememberMeToken
(long companyId, long userId, Date expirationDate, Consumer<String> valueConsumer) addRememberMeToken
(RememberMeToken rememberMeToken) Adds the remember me token to the database.createPersistedModel
(Serializable primaryKeyObj) createRememberMeToken
(long rememberMeTokenId) Creates a new remember me token with the primary key.void
deleteExpiredRememberMeTokens
(long userId) void
deleteExpiredRememberMeTokens
(Date expirationDate) deletePersistedModel
(PersistedModel persistedModel) deleteRememberMeToken
(long rememberMeTokenId) Deletes the remember me token with the primary key from the database.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) <T> List<T>
dynamicQuery
(DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.<T> 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> 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.fetchRememberMeToken
(long rememberMeTokenId) fetchRememberMeToken
(long rememberMeTokenId, String value) Returns the OSGi service identifier.getPersistedModel
(Serializable primaryKeyObj) getRememberMeToken
(long rememberMeTokenId) Returns the remember me token with the primary key.getRememberMeTokens
(int start, int end) Returns a range of all the remember me tokens.int
Returns the number of remember me tokens.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 Details
-
addRememberMeToken
RememberMeToken addRememberMeToken(long companyId, long userId, Date expirationDate, Consumer<String> valueConsumer) throws PwdEncryptorException - Throws:
PwdEncryptorException
-
addRememberMeToken
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
- Specified by:
createPersistedModel
in interfacePersistedModelLocalService
- Throws:
PortalException
-
createRememberMeToken
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
-
deleteExpiredRememberMeTokens
void deleteExpiredRememberMeTokens(long userId) -
deletePersistedModel
- Specified by:
deletePersistedModel
in interfacePersistedModelLocalService
- 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
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 interfacePersistedModelLocalService
-
dslQueryCount
@Transactional(propagation=SUPPORTS, readOnly=true) int dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) - Specified by:
dslQueryCount
in interfacePersistedModelLocalService
-
dynamicQuery
-
dynamicQuery
@Transactional(propagation=SUPPORTS, readOnly=true) <T> 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> 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
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
tocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS
will return the full result set. IforderByComparator
is specified, then the query will include the given ORDER BY logic. IforderByComparator
is absent, then the query will include the default ORDER BY logic fromcom.liferay.portal.model.impl.RememberMeTokenModelImpl
.- Parameters:
dynamicQuery
- the dynamic querystart
- the lower bound of the range of model instancesend
- the upper bound of the range of model instances (not inclusive)- Returns:
- the range of matching rows
-
dynamicQuery
@Transactional(propagation=SUPPORTS, readOnly=true) <T> 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
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
tocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS
will return the full result set. IforderByComparator
is specified, then the query will include the given ORDER BY logic. IforderByComparator
is absent, then the query will include the default ORDER BY logic fromcom.liferay.portal.model.impl.RememberMeTokenModelImpl
.- Parameters:
dynamicQuery
- the dynamic querystart
- the lower bound of the range of model instancesend
- the upper bound of the range of model instances (not inclusive)orderByComparator
- the comparator to order the results by (optionallynull
)- 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 queryprojection
- 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, String value) throws PwdEncryptorException - Throws:
PwdEncryptorException
-
getActionableDynamicQuery
@Transactional(propagation=SUPPORTS, readOnly=true) ActionableDynamicQuery getActionableDynamicQuery() -
getIndexableActionableDynamicQuery
@Transactional(propagation=SUPPORTS, readOnly=true) IndexableActionableDynamicQuery getIndexableActionableDynamicQuery() -
getOSGiServiceIdentifier
String getOSGiServiceIdentifier()Returns the OSGi service identifier.- Returns:
- the OSGi service identifier
-
getPersistedModel
@Transactional(propagation=SUPPORTS, readOnly=true) PersistedModel getPersistedModel(Serializable primaryKeyObj) throws PortalException - Specified by:
getPersistedModel
in interfacePersistedModelLocalService
- 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) 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
andend
are not primary keys, they are indexes in the result set. Thus,0
refers to the first result in the set. Setting bothstart
andend
tocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POS
will return the full result set. IforderByComparator
is specified, then the query will include the given ORDER BY logic. IforderByComparator
is absent, then the query will include the default ORDER BY logic fromcom.liferay.portal.model.impl.RememberMeTokenModelImpl
.- Parameters:
start
- the lower bound of the range of remember me tokensend
- the upper bound of the range of remember me tokens (not inclusive)- Returns:
- the range of remember me tokens
-
getRememberMeTokensCount
Returns the number of remember me tokens.- Returns:
- the number of remember me tokens
-
updateRememberMeToken
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
-