Interface PasswordPolicyLocalService
- All Superinterfaces:
BaseLocalService,PersistedModelLocalService
- All Known Implementing Classes:
PasswordPolicyLocalServiceWrapper
- Author:
- Brian Wing Shun Chan
- See Also:
- {$generated.description}
-
Method Summary
Modifier and TypeMethodDescriptionaddPasswordPolicy(long userId, boolean defaultPolicy, String name, String description, boolean changeable, boolean changeRequired, long minAge, boolean checkSyntax, boolean allowDictionaryWords, int minAlphanumeric, int minLength, int minLowerCase, int minNumbers, int minSymbols, int minUpperCase, 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) addPasswordPolicy(PasswordPolicy passwordPolicy) Adds the password policy to the database.voidcheckDefaultPasswordPolicy(long companyId) createPasswordPolicy(long passwordPolicyId) Creates a new password policy with the primary key.createPersistedModel(Serializable primaryKeyObj) voiddeleteNondefaultPasswordPolicies(long companyId) deletePasswordPolicy(long passwordPolicyId) Deletes the password policy with the primary key from the database.deletePasswordPolicy(PasswordPolicy passwordPolicy) Deletes the password policy from the database.deletePersistedModel(PersistedModel persistedModel) <T> TdslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) intdslQueryCount(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.longdynamicQueryCount(DynamicQuery dynamicQuery) Returns the number of rows matching the dynamic query.longdynamicQueryCount(DynamicQuery dynamicQuery, Projection projection) Returns the number of rows matching the dynamic query.fetchPasswordPolicy(long passwordPolicyId) fetchPasswordPolicy(long companyId, String name) fetchPasswordPolicyByUuidAndCompanyId(String uuid, long companyId) Returns the password policy with the matching UUID and company.getDefaultPasswordPolicy(long companyId) getExportActionableDynamicQuery(PortletDataContext portletDataContext) Returns the OSGi service identifier.getPasswordPolicies(int start, int end) Returns a range of all the password policies.intReturns the number of password policies.getPasswordPolicy(long passwordPolicyId) Returns the password policy with the primary key.getPasswordPolicy(long companyId, boolean defaultPolicy) getPasswordPolicy(long companyId, long[] organizationIds) getPasswordPolicyByUser(User user) getPasswordPolicyByUserId(long userId) getPasswordPolicyByUuidAndCompanyId(String uuid, long companyId) Returns the password policy with the matching UUID and company.getPersistedModel(Serializable primaryKeyObj) search(long companyId, String name, int start, int end, OrderByComparator<PasswordPolicy> orderByComparator) intsearchCount(long companyId, String name) updatePasswordPolicy(long passwordPolicyId, String name, String description, boolean changeable, boolean changeRequired, long minAge, boolean checkSyntax, boolean allowDictionaryWords, int minAlphanumeric, int minLength, int minLowerCase, int minNumbers, int minSymbols, int minUpperCase, 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) updatePasswordPolicy(PasswordPolicy passwordPolicy) Updates the password policy 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
-
addPasswordPolicy
PasswordPolicy addPasswordPolicy(long userId, boolean defaultPolicy, String name, String description, boolean changeable, boolean changeRequired, long minAge, boolean checkSyntax, boolean allowDictionaryWords, int minAlphanumeric, int minLength, int minLowerCase, int minNumbers, int minSymbols, int minUpperCase, 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 - Throws:
PortalException
-
addPasswordPolicy
Adds the password policy to the database. Also notifies the appropriate model listeners.Important: Inspect PasswordPolicyLocalServiceImpl 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:
passwordPolicy- the password policy- Returns:
- the password policy that was added
-
checkDefaultPasswordPolicy
- Throws:
PortalException
-
createPasswordPolicy
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
-
createPersistedModel
- Specified by:
createPersistedModelin interfacePersistedModelLocalService- Throws:
PortalException
-
deleteNondefaultPasswordPolicies
- Throws:
PortalException
-
deletePasswordPolicy
@Indexable(type=DELETE) PasswordPolicy deletePasswordPolicy(long passwordPolicyId) throws PortalException Deletes the password policy with the primary key from the database. Also notifies the appropriate model listeners.Important: Inspect PasswordPolicyLocalServiceImpl 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:
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
-
deletePasswordPolicy
@Indexable(type=DELETE) @SystemEvent(action=1, type=1) PasswordPolicy deletePasswordPolicy(PasswordPolicy passwordPolicy) throws PortalException Deletes the password policy from the database. Also notifies the appropriate model listeners.Important: Inspect PasswordPolicyLocalServiceImpl 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:
passwordPolicy- the password policy- Returns:
- the password policy that was removed
- Throws:
PortalException
-
deletePersistedModel
- Specified by:
deletePersistedModelin interfacePersistedModelLocalService- Throws:
PortalException
-
dslQuery
@Transactional(propagation=SUPPORTS, readOnly=true) <T> T dslQuery(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) - Specified by:
dslQueryin interfacePersistedModelLocalService
-
dslQueryCount
@Transactional(propagation=SUPPORTS, readOnly=true) int dslQueryCount(com.liferay.petra.sql.dsl.query.DSLQuery dslQuery) - Specified by:
dslQueryCountin 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 - startinstances.startandendare not primary keys, they are indexes in the result set. Thus,0refers to the first result in the set. Setting bothstartandendtocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POSwill return the full result set. IforderByComparatoris specified, then the query will include the given ORDER BY logic. IforderByComparatoris absent, then the query will include the default ORDER BY logic fromcom.liferay.portal.model.impl.PasswordPolicyModelImpl.- 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 - startinstances.startandendare not primary keys, they are indexes in the result set. Thus,0refers to the first result in the set. Setting bothstartandendtocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POSwill return the full result set. IforderByComparatoris specified, then the query will include the given ORDER BY logic. IforderByComparatoris absent, then the query will include the default ORDER BY logic fromcom.liferay.portal.model.impl.PasswordPolicyModelImpl.- 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
-
fetchPasswordPolicy
@Transactional(propagation=SUPPORTS, readOnly=true) PasswordPolicy fetchPasswordPolicy(long passwordPolicyId) -
fetchPasswordPolicy
@Transactional(propagation=SUPPORTS, readOnly=true) PasswordPolicy fetchPasswordPolicy(long companyId, String name) -
fetchPasswordPolicyByUuidAndCompanyId
@Transactional(propagation=SUPPORTS, readOnly=true) PasswordPolicy fetchPasswordPolicyByUuidAndCompanyId(String uuid, long companyId) Returns the password policy with the matching UUID and company.- Parameters:
uuid- the password policy's UUIDcompanyId- the primary key of the company- Returns:
- the matching password policy, or
nullif a matching password policy could not be found
-
getActionableDynamicQuery
@Transactional(propagation=SUPPORTS, readOnly=true) ActionableDynamicQuery getActionableDynamicQuery() -
getDefaultPasswordPolicy
@Transactional(propagation=SUPPORTS, readOnly=true) PasswordPolicy getDefaultPasswordPolicy(long companyId) throws PortalException - Throws:
PortalException
-
getExportActionableDynamicQuery
@Transactional(propagation=SUPPORTS, readOnly=true) ExportActionableDynamicQuery getExportActionableDynamicQuery(PortletDataContext portletDataContext) -
getIndexableActionableDynamicQuery
@Transactional(propagation=SUPPORTS, readOnly=true) IndexableActionableDynamicQuery getIndexableActionableDynamicQuery() -
getOSGiServiceIdentifier
String getOSGiServiceIdentifier()Returns the OSGi service identifier.- Returns:
- the OSGi service identifier
-
getPasswordPolicies
@Transactional(propagation=SUPPORTS, readOnly=true) List<PasswordPolicy> getPasswordPolicies(int start, int end) Returns a range of all the password policies.Useful when paginating results. Returns a maximum of
end - startinstances.startandendare not primary keys, they are indexes in the result set. Thus,0refers to the first result in the set. Setting bothstartandendtocom.liferay.portal.kernel.dao.orm.QueryUtil#ALL_POSwill return the full result set. IforderByComparatoris specified, then the query will include the given ORDER BY logic. IforderByComparatoris absent, then the query will include the default ORDER BY logic fromcom.liferay.portal.model.impl.PasswordPolicyModelImpl.- Parameters:
start- the lower bound of the range of password policiesend- the upper bound of the range of password policies (not inclusive)- Returns:
- the range of password policies
-
getPasswordPoliciesCount
Returns the number of password policies.- Returns:
- the number of password policies
-
getPasswordPolicy
@Transactional(propagation=SUPPORTS, readOnly=true) PasswordPolicy getPasswordPolicy(long passwordPolicyId) throws PortalException 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
-
getPasswordPolicy
@Transactional(propagation=SUPPORTS, readOnly=true) PasswordPolicy getPasswordPolicy(long companyId, boolean defaultPolicy) throws PortalException - Throws:
PortalException
-
getPasswordPolicy
@Transactional(propagation=SUPPORTS, readOnly=true) PasswordPolicy getPasswordPolicy(long companyId, long[] organizationIds) throws PortalException - Throws:
PortalException
-
getPasswordPolicyByUser
@Transactional(propagation=SUPPORTS, readOnly=true) PasswordPolicy getPasswordPolicyByUser(User user) throws PortalException - Throws:
PortalException
-
getPasswordPolicyByUserId
@ThreadLocalCachable @Transactional(propagation=SUPPORTS, readOnly=true) PasswordPolicy getPasswordPolicyByUserId(long userId) throws PortalException - Throws:
PortalException
-
getPasswordPolicyByUuidAndCompanyId
@Transactional(propagation=SUPPORTS, readOnly=true) PasswordPolicy getPasswordPolicyByUuidAndCompanyId(String uuid, long companyId) throws PortalException Returns the password policy with the matching UUID and company.- Parameters:
uuid- the password policy's UUIDcompanyId- the primary key of the company- Returns:
- the matching password policy
- Throws:
PortalException- if a matching password policy could not be found
-
getPersistedModel
@Transactional(propagation=SUPPORTS, readOnly=true) PersistedModel getPersistedModel(Serializable primaryKeyObj) throws PortalException - Specified by:
getPersistedModelin interfacePersistedModelLocalService- Throws:
PortalException
-
search
@Transactional(propagation=SUPPORTS, readOnly=true) List<PasswordPolicy> search(long companyId, String name, int start, int end, OrderByComparator<PasswordPolicy> orderByComparator) -
searchCount
-
updatePasswordPolicy
PasswordPolicy updatePasswordPolicy(long passwordPolicyId, String name, String description, boolean changeable, boolean changeRequired, long minAge, boolean checkSyntax, boolean allowDictionaryWords, int minAlphanumeric, int minLength, int minLowerCase, int minNumbers, int minSymbols, int minUpperCase, 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 - Throws:
PortalException
-
updatePasswordPolicy
Updates the password policy in the database or adds it if it does not yet exist. Also notifies the appropriate model listeners.Important: Inspect PasswordPolicyLocalServiceImpl 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:
passwordPolicy- the password policy- Returns:
- the password policy that was updated
-