Liferay 6.1.2-ce-ga3

com.liferay.portal.service
Interface PasswordPolicyLocalService

All Superinterfaces:
BaseLocalService, PersistedModelLocalService
All Known Implementing Classes:
PasswordPolicyLocalServiceWrapper

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

The interface for the password policy local service.

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, com.liferay.portal.service.impl.PasswordPolicyLocalServiceImpl

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.
 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()
           
 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)
          Returns the number of rows that match the dynamic query.
 PasswordPolicy fetchPasswordPolicy(long passwordPolicyId)
           
 String getBeanIdentifier()
          Returns the Spring bean ID for this bean.
 PasswordPolicy getDefaultPasswordPolicy(long companyId)
           
 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.  
 PasswordPolicy getPasswordPolicyByUserId(long userId)
           
 PersistedModel getPersistedModel(Serializable primaryKeyObj)
           
 List<PasswordPolicy> search(long companyId, String name, int start, int end, OrderByComparator obc)
           
 int searchCount(long companyId, String name)
           
 void setBeanIdentifier(String beanIdentifier)
          Sets the Spring bean ID for this bean.
 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 or adds it if it does not yet exist.
 PasswordPolicy updatePasswordPolicy(PasswordPolicy passwordPolicy, boolean merge)
          Updates the password policy in the database or adds it if it does not yet exist.
 

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
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

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

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

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

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
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

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
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

fetchPasswordPolicy

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

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(Serializable primaryKeyObj)
                                 throws PortalException,
                                        SystemException
Specified by:
getPersistedModel in interface PersistedModelLocalService
Throws:
PortalException
SystemException

getPasswordPolicies

@Transactional(propagation=SUPPORTS,
               readOnly=true)
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.

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

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

updatePasswordPolicy

PasswordPolicy updatePasswordPolicy(PasswordPolicy passwordPolicy,
                                    boolean merge)
                                    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
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

getBeanIdentifier

String getBeanIdentifier()
Returns the Spring bean ID for this bean.

Returns:
the Spring bean ID for this bean

setBeanIdentifier

void setBeanIdentifier(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,
                                 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.1.2-ce-ga3