Liferay 6.0.5

com.liferay.portal.service
Interface PasswordPolicyLocalService

All Known Implementing Classes:
PasswordPolicyLocalServiceBaseImpl, PasswordPolicyLocalServiceImpl, PasswordPolicyLocalServiceWrapper

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

The interface for the password policy local service.

Never modify or reference this interface directly. Always use PasswordPolicyLocalServiceUtil to access the password policy local service. Add custom service methods to PasswordPolicyLocalServiceImpl and rerun ServiceBuilder to automatically copy the method declarations to this interface.

This is a local service. 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:
PasswordPolicyLocalServiceUtil, PasswordPolicyLocalServiceBaseImpl, PasswordPolicyLocalServiceImpl
ServiceBuilder generated this class. Modifications in this class will be overwritten the next time is generated.

Method Summary
 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, boolean history, int historyCount, boolean expireable, long maxAge, long warningTime, int graceLimit, boolean lockout, int maxFailure, long lockoutDuration, long resetFailureCount, long resetTicketMaxAge)
           
 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 deletePasswordPolicy(long passwordPolicyId)
          Deletes the password policy with the primary key from the database.
 void deletePasswordPolicy(PasswordPolicy passwordPolicy)
          Deletes the password policy from the database.
 List dynamicQuery(DynamicQuery dynamicQuery)
          Performs a dynamic query on the database and returns the matching rows.
 List dynamicQuery(DynamicQuery dynamicQuery, int start, int end)
          Performs a dynamic query on the database and returns a range of the matching rows.
 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)
          Counts the number of rows that match the dynamic query.
 PasswordPolicy getDefaultPasswordPolicy(long companyId)
           
 List<PasswordPolicy> getPasswordPolicies(int start, int end)
          Gets a range of all the password policies.
 int getPasswordPoliciesCount()
          Gets the number of password policies.
 PasswordPolicy getPasswordPolicy(long passwordPolicyId)
          Gets the password policy with the primary key.
 PasswordPolicy getPasswordPolicy(long companyId, long[] organizationIds)
           
 PasswordPolicy getPasswordPolicy(long companyId, long organizationId, long locationId)
          Deprecated.  
 PasswordPolicy getPasswordPolicyByUserId(long userId)
           
 List<PasswordPolicy> search(long companyId, String name, int start, int end, OrderByComparator obc)
           
 int searchCount(long companyId, String name)
           
 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, boolean history, int historyCount, boolean expireable, long maxAge, long warningTime, int graceLimit, boolean lockout, int maxFailure, long lockoutDuration, long resetFailureCount, long resetTicketMaxAge)
           
 PasswordPolicy updatePasswordPolicy(PasswordPolicy passwordPolicy)
          Updates the password policy in the database.
 PasswordPolicy updatePasswordPolicy(PasswordPolicy passwordPolicy, boolean merge)
          Updates the password policy in the database.
 

Method Detail

addPasswordPolicy

PasswordPolicy addPasswordPolicy(PasswordPolicy passwordPolicy)
                                 throws SystemException
Adds the password policy to the database. Also notifies the appropriate model listeners.

Parameters:
passwordPolicy - the password policy to add
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

void 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 to delete
Throws:
PortalException - if a password policy with the primary key could not be found
SystemException - if a system exception occurred

deletePasswordPolicy

void deletePasswordPolicy(PasswordPolicy passwordPolicy)
                          throws SystemException
Deletes the password policy from the database. Also notifies the appropriate model listeners.

Parameters:
passwordPolicy - the password policy to delete
Throws:
SystemException - if a system exception occurred

dynamicQuery

List dynamicQuery(DynamicQuery dynamicQuery)
                  throws SystemException
Performs a dynamic query on the database and returns the matching rows.

Parameters:
dynamicQuery - the dynamic query to search with
Returns:
the matching rows
Throws:
SystemException - if a system exception occurred

dynamicQuery

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.

Parameters:
dynamicQuery - the dynamic query to search with
start - the lower bound of the range of model instances to return
end - the upper bound of the range of model instances to return (not inclusive)
Returns:
the range of matching rows
Throws:
SystemException - if a system exception occurred

dynamicQuery

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.

Parameters:
dynamicQuery - the dynamic query to search with
start - the lower bound of the range of model instances to return
end - the upper bound of the range of model instances to return (not inclusive)
orderByComparator - the comparator to order the results by
Returns:
the ordered range of matching rows
Throws:
SystemException - if a system exception occurred

dynamicQueryCount

long dynamicQueryCount(DynamicQuery dynamicQuery)
                       throws SystemException
Counts the number of rows that match the dynamic query.

Parameters:
dynamicQuery - the dynamic query to search with
Returns:
the number of rows that match the dynamic query
Throws:
SystemException - if a system exception occurred

getPasswordPolicy

@Transactional(propagation=SUPPORTS,
               readOnly=true)
PasswordPolicy getPasswordPolicy(long passwordPolicyId)
                                 throws PortalException,
                                        SystemException
Gets the password policy with the primary key.

Parameters:
passwordPolicyId - the primary key of the password policy to get
Returns:
the password policy
Throws:
PortalException - if a password policy with the primary key could not be found
SystemException - if a system exception occurred

getPasswordPolicies

@Transactional(propagation=SUPPORTS,
               readOnly=true)
List<PasswordPolicy> getPasswordPolicies(int start,
                                                                                  int end)
                                         throws SystemException
Gets 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.

Parameters:
start - the lower bound of the range of password policies to return
end - the upper bound of the range of password policies to return (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
Gets the number of password policies.

Returns:
the number of password policies
Throws:
SystemException - if a system exception occurred

updatePasswordPolicy

PasswordPolicy updatePasswordPolicy(PasswordPolicy passwordPolicy)
                                    throws SystemException
Updates the password policy in the database. Also notifies the appropriate model listeners.

Parameters:
passwordPolicy - the password policy to update
Returns:
the password policy that was updated
Throws:
SystemException - if a system exception occurred

updatePasswordPolicy

PasswordPolicy updatePasswordPolicy(PasswordPolicy passwordPolicy,
                                    boolean merge)
                                    throws SystemException
Updates the password policy in the database. Also notifies the appropriate model listeners.

Parameters:
passwordPolicy - the password policy to update
merge - whether to merge the password policy with the current session. See BatchSession.update(com.liferay.portal.kernel.dao.orm.Session, com.liferay.portal.model.BaseModel, boolean) for an explanation.
Returns:
the password policy that was updated
Throws:
SystemException - if a system exception occurred

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,
                                 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
Throws:
PortalException
SystemException

checkDefaultPasswordPolicy

void checkDefaultPasswordPolicy(long companyId)
                                throws PortalException,
                                       SystemException
Throws:
PortalException
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. 

Throws:
PortalException
SystemException

getPasswordPolicy

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

getPasswordPolicyByUserId

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

search

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

searchCount

@Transactional(propagation=SUPPORTS,
               readOnly=true)
int searchCount(long companyId,
                                                         String name)
                throws SystemException
Throws:
SystemException

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,
                                    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
Throws:
PortalException
SystemException

Liferay 6.0.5