com.liferay.portal.service

Interface PasswordPolicyLocalService

All Superinterfaces:

BaseLocalService, PersistedModelLocalService

All Known Implementing Classes:

PasswordPolicyLocalServiceWrapper

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

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

PasswordPolicyLocalServiceUtil, PasswordPolicyLocalServiceBaseImpl, com.liferay.portal.service.impl.PasswordPolicyLocalServiceImpl

Generated:

Method Summary

Methods

Modifier and Type	Method and Description
PasswordPolicy	addPasswordPolicy(long userId, boolean defaultPolicy, java.lang.String name, java.lang.String description, boolean changeable, boolean changeRequired, long minAge, boolean checkSyntax, boolean allowDictionaryWords, int minAlphanumeric, int minLength, int minLowerCase, int minNumbers, int minSymbols, int minUpperCase, boolean history, int historyCount, boolean expireable, long maxAge, long warningTime, int graceLimit, boolean lockout, int maxFailure, long lockoutDuration, long resetFailureCount, long resetTicketMaxAge) Deprecated. As of 6.2.0, replaced by addPasswordPolicy(long, boolean, String, String, boolean, boolean, long, boolean, boolean, int, int, int, int, int, int, String, boolean, int, boolean, long, long, int, boolean, int, long, long, long, ServiceContext)
PasswordPolicy	addPasswordPolicy(long userId, boolean defaultPolicy, java.lang.String name, java.lang.String description, boolean changeable, boolean changeRequired, long minAge, boolean checkSyntax, boolean allowDictionaryWords, int minAlphanumeric, int minLength, int minLowerCase, int minNumbers, int minSymbols, int minUpperCase, java.lang.String regex, boolean history, int historyCount, boolean expireable, long maxAge, long warningTime, int graceLimit, boolean lockout, int maxFailure, long lockoutDuration, long resetFailureCount, long resetTicketMaxAge, ServiceContext serviceContext)
PasswordPolicy	addPasswordPolicy(PasswordPolicy passwordPolicy) Adds the password policy to the database.
void	checkDefaultPasswordPolicy(long companyId)
PasswordPolicy	createPasswordPolicy(long passwordPolicyId) Creates a new password policy with the primary key.
void	deleteNondefaultPasswordPolicies(long companyId)
PasswordPolicy	deletePasswordPolicy(long passwordPolicyId) Deletes the password policy with the primary key from the database.
PasswordPolicy	deletePasswordPolicy(PasswordPolicy passwordPolicy) Deletes the password policy from the database.
DynamicQuery	dynamicQuery()
java.util.List	dynamicQuery(DynamicQuery dynamicQuery) Performs a dynamic query on the database and returns the matching rows.
java.util.List	dynamicQuery(DynamicQuery dynamicQuery, int start, int end) Performs a dynamic query on the database and returns a range of the matching rows.
java.util.List	dynamicQuery(DynamicQuery dynamicQuery, int start, int end, OrderByComparator 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 that match the dynamic query.
long	dynamicQueryCount(DynamicQuery dynamicQuery, Projection projection) Returns the number of rows that match the dynamic query.
PasswordPolicy	fetchPasswordPolicy(long passwordPolicyId)
PasswordPolicy	fetchPasswordPolicy(long companyId, java.lang.String name)
PasswordPolicy	fetchPasswordPolicyByUuidAndCompanyId(java.lang.String uuid, long companyId) Returns the password policy with the matching UUID and company.
java.lang.String	getBeanIdentifier() Returns the Spring bean ID for this bean.
PasswordPolicy	getDefaultPasswordPolicy(long companyId)
java.util.List<PasswordPolicy>	getPasswordPolicies(int start, int end) Returns a range of all the password policies.
int	getPasswordPoliciesCount() Returns the number of password policies.
PasswordPolicy	getPasswordPolicy(long passwordPolicyId) Returns the password policy with the primary key.
PasswordPolicy	getPasswordPolicy(long companyId, long[] organizationIds)
PasswordPolicy	getPasswordPolicy(long companyId, long organizationId, long locationId) Deprecated. As of 6.1.0
PasswordPolicy	getPasswordPolicyByUserId(long userId)
PasswordPolicy	getPasswordPolicyByUuidAndCompanyId(java.lang.String uuid, long companyId) Returns the password policy with the matching UUID and company.
PersistedModel	getPersistedModel(java.io.Serializable primaryKeyObj)
java.util.List<PasswordPolicy>	search(long companyId, java.lang.String name, int start, int end, OrderByComparator obc)
int	searchCount(long companyId, java.lang.String name)
void	setBeanIdentifier(java.lang.String beanIdentifier) Sets the Spring bean ID for this bean.
PasswordPolicy	updatePasswordPolicy(long passwordPolicyId, java.lang.String name, java.lang.String description, boolean changeable, boolean changeRequired, long minAge, boolean checkSyntax, boolean allowDictionaryWords, int minAlphanumeric, int minLength, int minLowerCase, int minNumbers, int minSymbols, int minUpperCase, boolean history, int historyCount, boolean expireable, long maxAge, long warningTime, int graceLimit, boolean lockout, int maxFailure, long lockoutDuration, long resetFailureCount, long resetTicketMaxAge) Deprecated. As of 6.2.0, replaced by updatePasswordPolicy(long, String, String, boolean, boolean, long, boolean, boolean, int, int, int, int, int, int, String, boolean, int, boolean, long, long, int, boolean, int, long, long, long, ServiceContext)
PasswordPolicy	updatePasswordPolicy(long passwordPolicyId, java.lang.String name, java.lang.String description, boolean changeable, boolean changeRequired, long minAge, boolean checkSyntax, boolean allowDictionaryWords, int minAlphanumeric, int minLength, int minLowerCase, int minNumbers, int minSymbols, int minUpperCase, java.lang.String regex, boolean history, int historyCount, boolean expireable, long maxAge, long warningTime, int graceLimit, boolean lockout, int maxFailure, long lockoutDuration, long resetFailureCount, long resetTicketMaxAge, ServiceContext serviceContext)
PasswordPolicy	updatePasswordPolicy(PasswordPolicy passwordPolicy) Updates the password policy in the database or adds it if it does not yet exist.

Method Detail

addPasswordPolicy

@Indexable(type=REINDEX)
PasswordPolicy addPasswordPolicy(PasswordPolicy passwordPolicy)
                                 throws SystemException

Adds the password policy to the database. Also notifies the appropriate model listeners.

Parameters:

passwordPolicy - the password policy

Returns:

the password policy that was added

Throws:

SystemException - if a system exception occurred

createPasswordPolicy

PasswordPolicy createPasswordPolicy(long passwordPolicyId)

Creates a new password policy with the primary key. Does not add the password policy to the database.

Parameters:

passwordPolicyId - the primary key for the new password policy

Returns:

the new password policy

deletePasswordPolicy

@Indexable(type=DELETE)
PasswordPolicy deletePasswordPolicy(long passwordPolicyId)
                                    throws PortalException,
                                           SystemException

Deletes the password policy with the primary key from the database. Also notifies the appropriate model listeners.

Parameters:

passwordPolicyId - the primary key of the password policy

Returns:

the password policy that was removed

Throws:

PortalException - if a password policy with the primary key could not be found

SystemException - if a system exception occurred

deletePasswordPolicy

@Indexable(type=DELETE)
PasswordPolicy deletePasswordPolicy(PasswordPolicy passwordPolicy)
                                    throws PortalException,
                                           SystemException

Deletes the password policy from the database. Also notifies the appropriate model listeners.

Parameters:

passwordPolicy - the password policy

Returns:

the password policy that was removed

Throws:

PortalException

SystemException - if a system exception occurred

dynamicQuery

DynamicQuery dynamicQuery()

dynamicQuery

java.util.List dynamicQuery(DynamicQuery dynamicQuery)
                            throws SystemException

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

Parameters:

dynamicQuery - the dynamic query

Returns:

the matching rows

Throws:

SystemException - if a system exception occurred

dynamicQuery

java.util.List dynamicQuery(DynamicQuery dynamicQuery,
                          int start,
                          int end)
                            throws SystemException

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 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 QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from PasswordPolicyModelImpl. 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.

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

Throws:

SystemException - if a system exception occurred

dynamicQuery

java.util.List dynamicQuery(DynamicQuery dynamicQuery,
                          int start,
                          int end,
                          OrderByComparator orderByComparator)
                            throws SystemException

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 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 QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from PasswordPolicyModelImpl. 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.

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

Throws:

SystemException - if a system exception occurred

dynamicQueryCount

long dynamicQueryCount(DynamicQuery dynamicQuery)
                       throws SystemException

Returns the number of rows that match the dynamic query.

Parameters:

dynamicQuery - the dynamic query

Returns:

the number of rows that match the dynamic query

Throws:

SystemException - if a system exception occurred

dynamicQueryCount

long dynamicQueryCount(DynamicQuery dynamicQuery,
                     Projection projection)
                       throws SystemException

Returns the number of rows that match the dynamic query.

Parameters:

dynamicQuery - the dynamic query

projection - the projection to apply to the query

Returns:

the number of rows that match the dynamic query

Throws:

SystemException - if a system exception occurred

fetchPasswordPolicy

@Transactional(propagation=SUPPORTS,
               readOnly=true)
PasswordPolicy fetchPasswordPolicy(long passwordPolicyId)
                                   throws SystemException

Throws:

SystemException

fetchPasswordPolicyByUuidAndCompanyId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
PasswordPolicy fetchPasswordPolicyByUuidAndCompanyId(java.lang.String uuid,
                                                                                            long companyId)
                                                     throws SystemException

Returns the password policy with the matching UUID and company.

Parameters:

uuid - the password policy's UUID

companyId - the primary key of the company

Returns:

the matching password policy, or null if a matching password policy could not be found

Throws:

SystemException - if a system exception occurred

getPasswordPolicy

@Transactional(propagation=SUPPORTS,
               readOnly=true)
PasswordPolicy getPasswordPolicy(long passwordPolicyId)
                                 throws PortalException,
                                        SystemException

Returns the password policy with the primary key.

Parameters:

passwordPolicyId - the primary key of the password policy

Returns:

the password policy

Throws:

PortalException - if a password policy with the primary key could not be found

SystemException - if a system exception occurred

getPersistedModel

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

Specified by:

getPersistedModel in interface PersistedModelLocalService

Throws:

PortalException

SystemException

getPasswordPolicyByUuidAndCompanyId

@Transactional(propagation=SUPPORTS,
               readOnly=true)
PasswordPolicy getPasswordPolicyByUuidAndCompanyId(java.lang.String uuid,
                                                                                          long companyId)
                                                   throws PortalException,
                                                          SystemException

Returns the password policy with the matching UUID and company.

Parameters:

uuid - the password policy's UUID

companyId - the primary key of the company

Returns:

the matching password policy

Throws:

PortalException - if a matching password policy could not be found

SystemException - if a system exception occurred

getPasswordPolicies

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<PasswordPolicy> getPasswordPolicies(int start,
                                                                                          int end)
                                                   throws SystemException

Returns a range of all the password policies.

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 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 QueryUtil.ALL_POS), then the query will include the default ORDER BY logic from PasswordPolicyModelImpl. 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.

Parameters:

start - the lower bound of the range of password policies

end - the upper bound of the range of password policies (not inclusive)

Returns:

the range of password policies

Throws:

SystemException - if a system exception occurred

getPasswordPoliciesCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int getPasswordPoliciesCount()
                             throws SystemException

Returns the number of password policies.

Returns:

the number of password policies

Throws:

SystemException - if a system exception occurred

updatePasswordPolicy

@Indexable(type=REINDEX)
PasswordPolicy updatePasswordPolicy(PasswordPolicy passwordPolicy)
                                    throws SystemException

Updates the password policy in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.

Parameters:

passwordPolicy - the password policy

Returns:

the password policy that was updated

Throws:

SystemException - if a system exception occurred

getBeanIdentifier

java.lang.String getBeanIdentifier()

Returns the Spring bean ID for this bean.

Returns:

the Spring bean ID for this bean

setBeanIdentifier

void setBeanIdentifier(java.lang.String beanIdentifier)

Sets the Spring bean ID for this bean.

Parameters:

beanIdentifier - the Spring bean ID for this bean

addPasswordPolicy

PasswordPolicy addPasswordPolicy(long userId,
                               boolean defaultPolicy,
                               java.lang.String name,
                               java.lang.String description,
                               boolean changeable,
                               boolean changeRequired,
                               long minAge,
                               boolean checkSyntax,
                               boolean allowDictionaryWords,
                               int minAlphanumeric,
                               int minLength,
                               int minLowerCase,
                               int minNumbers,
                               int minSymbols,
                               int minUpperCase,
                               boolean history,
                               int historyCount,
                               boolean expireable,
                               long maxAge,
                               long warningTime,
                               int graceLimit,
                               boolean lockout,
                               int maxFailure,
                               long lockoutDuration,
                               long resetFailureCount,
                               long resetTicketMaxAge)
                                 throws PortalException,
                                        SystemException

Deprecated. As of 6.2.0, replaced by addPasswordPolicy(long, boolean, String, String, boolean, boolean, long, boolean, boolean, int, int, int, int, int, int, String, boolean, int, boolean, long, long, int, boolean, int, long, long, long, ServiceContext)

Throws:

PortalException

SystemException

addPasswordPolicy

PasswordPolicy addPasswordPolicy(long userId,
                               boolean defaultPolicy,
                               java.lang.String name,
                               java.lang.String description,
                               boolean changeable,
                               boolean changeRequired,
                               long minAge,
                               boolean checkSyntax,
                               boolean allowDictionaryWords,
                               int minAlphanumeric,
                               int minLength,
                               int minLowerCase,
                               int minNumbers,
                               int minSymbols,
                               int minUpperCase,
                               java.lang.String regex,
                               boolean history,
                               int historyCount,
                               boolean expireable,
                               long maxAge,
                               long warningTime,
                               int graceLimit,
                               boolean lockout,
                               int maxFailure,
                               long lockoutDuration,
                               long resetFailureCount,
                               long resetTicketMaxAge,
                               ServiceContext serviceContext)
                                 throws PortalException,
                                        SystemException

Throws:

PortalException

SystemException

checkDefaultPasswordPolicy

void checkDefaultPasswordPolicy(long companyId)
                                throws PortalException,
                                       SystemException

Throws:

PortalException

SystemException

deleteNondefaultPasswordPolicies

void deleteNondefaultPasswordPolicies(long companyId)
                                      throws PortalException,
                                             SystemException

Throws:

PortalException

SystemException

fetchPasswordPolicy

@Transactional(propagation=SUPPORTS,
               readOnly=true)
PasswordPolicy fetchPasswordPolicy(long companyId,
                                                                          java.lang.String name)
                                   throws SystemException

Throws:

SystemException

getDefaultPasswordPolicy

@Transactional(propagation=SUPPORTS,
               readOnly=true)
PasswordPolicy getDefaultPasswordPolicy(long companyId)
                                        throws PortalException,
                                               SystemException

Throws:

PortalException

SystemException

getPasswordPolicy

@Transactional(propagation=SUPPORTS,
               readOnly=true)
PasswordPolicy getPasswordPolicy(long companyId,
                                                                        long organizationId,
                                                                        long locationId)
                                 throws PortalException,
                                        SystemException

Deprecated. As of 6.1.0

Throws:

PortalException

SystemException

getPasswordPolicy

@Transactional(propagation=SUPPORTS,
               readOnly=true)
PasswordPolicy getPasswordPolicy(long companyId,
                                                                        long[] organizationIds)
                                 throws PortalException,
                                        SystemException

Throws:

PortalException

SystemException

getPasswordPolicyByUserId

@ThreadLocalCachable
@Transactional(propagation=SUPPORTS,
               readOnly=true)
PasswordPolicy getPasswordPolicyByUserId(long userId)
                                         throws PortalException,
                                                SystemException

Throws:

PortalException

SystemException

search

@Transactional(propagation=SUPPORTS,
               readOnly=true)
java.util.List<PasswordPolicy> search(long companyId,
                                                                             java.lang.String name,
                                                                             int start,
                                                                             int end,
                                                                             OrderByComparator obc)
                                      throws SystemException

Throws:

SystemException

searchCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int searchCount(long companyId,
                                                       java.lang.String name)
                throws SystemException

Throws:

SystemException

updatePasswordPolicy

PasswordPolicy updatePasswordPolicy(long passwordPolicyId,
                                  java.lang.String name,
                                  java.lang.String description,
                                  boolean changeable,
                                  boolean changeRequired,
                                  long minAge,
                                  boolean checkSyntax,
                                  boolean allowDictionaryWords,
                                  int minAlphanumeric,
                                  int minLength,
                                  int minLowerCase,
                                  int minNumbers,
                                  int minSymbols,
                                  int minUpperCase,
                                  boolean history,
                                  int historyCount,
                                  boolean expireable,
                                  long maxAge,
                                  long warningTime,
                                  int graceLimit,
                                  boolean lockout,
                                  int maxFailure,
                                  long lockoutDuration,
                                  long resetFailureCount,
                                  long resetTicketMaxAge)
                                    throws PortalException,
                                           SystemException

Deprecated. As of 6.2.0, replaced by updatePasswordPolicy(long, String, String, boolean, boolean, long, boolean, boolean, int, int, int, int, int, int, String, boolean, int, boolean, long, long, int, boolean, int, long, long, long, ServiceContext)

Throws:

PortalException

SystemException

updatePasswordPolicy

PasswordPolicy updatePasswordPolicy(long passwordPolicyId,
                                  java.lang.String name,
                                  java.lang.String description,
                                  boolean changeable,
                                  boolean changeRequired,
                                  long minAge,
                                  boolean checkSyntax,
                                  boolean allowDictionaryWords,
                                  int minAlphanumeric,
                                  int minLength,
                                  int minLowerCase,
                                  int minNumbers,
                                  int minSymbols,
                                  int minUpperCase,
                                  java.lang.String regex,
                                  boolean history,
                                  int historyCount,
                                  boolean expireable,
                                  long maxAge,
                                  long warningTime,
                                  int graceLimit,
                                  boolean lockout,
                                  int maxFailure,
                                  long lockoutDuration,
                                  long resetFailureCount,
                                  long resetTicketMaxAge,
                                  ServiceContext serviceContext)
                                    throws PortalException,
                                           SystemException

Throws:

PortalException

SystemException