com.crm.businessobject.users

Class CRMBOUserBean

java.lang.Object

com.crm.businessobject.CRMBase

com.crm.businessobject.CRMBO

com.crm.businessobject.users.CRMBOUserBean

All Implemented Interfaces:

java.io.Serializable

public class CRMBOUserBean
extends CRMBO

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
CRMBOUserBean() Default constructor.

Method Summary

Modifier and Type	Method and Description
java.util.Date	calculatePasswordExpirationDate(com.crm.dataobject.users.CRMDOUser user) Calculates the password expiration date of the given user
void	cancelLockOutPeriod(com.crm.dataobject.users.CRMDOUser user) Updates the USERLOCKOUTTIME table.
java.lang.Boolean	exists(com.crm.dataobject.users.CRMDOUser user) Checks if the user exists in the database.
java.util.ArrayList<java.lang.String>	getDefaultAssociations() Returns the default associated data objects of a user.
java.util.Date	getLockOutTimeStartDate(com.crm.dataobject.users.CRMDOUser user) Returns the lock out start date period.
com.crm.dataobject.users.CRMDOUser	initialize(com.crm.dataobject.users.CRMDOUser user, com.crm.dataobject.users.CRMDOUserTemplate userTemplate) Initializes a user from a user template.
java.lang.Boolean	isInLockOutPeriod(com.crm.dataobject.users.CRMDOUser user) Checks if a user is in lock out period.
java.util.ArrayList<com.crm.dataobject.CRMDO>	load(com.crm.dataobject.networkmanagement.CRMDOCommunity community) Loads a list of user for a community
java.util.ArrayList<com.crm.dataobject.CRMDO>	load(com.crm.dataobject.contactinfo.CRMDOContactInfoEmail contactInfoEmail) Loads a list of users based on a contact information email.
java.util.ArrayList<com.crm.dataobject.CRMDO>	load(com.crm.dataobject.contactinfo.CRMDOContactInformation contactInformation) Loads a list of users based on a contact.
java.util.ArrayList	load(com.crm.dataobject.securitymanagement.CRMDOSecurityProfile securityProfile, java.lang.Boolean active) Loads a list of users (active and/or inactive) based on a security profile.
java.util.ArrayList	load(com.crm.dataobject.networkmanagement.CRMDOUnit unit) Loads a list of user for a unit
java.util.ArrayList<com.crm.dataobject.CRMDO>	load(com.crm.dataobject.networkmanagement.CRMDOUnitGroup group) Loads a list of user for a group
java.util.ArrayList<com.crm.dataobject.CRMDO>	loadActive(com.crm.dataobject.securitymanagement.CRMDOSecurityProfile securityProfile)
java.util.ArrayList<com.crm.dataobject.CRMDO>	loadActiveWithEmail()
com.crm.dataobject.users.CRMDOUser	loadByEmail(java.lang.String email, java.util.ArrayList<java.lang.String> associations) Loads a user based on an email address.
com.crm.dataobject.users.CRMDOUser	loadByUsername(java.lang.String username) Loads a user based on a username.
com.crm.dataobject.users.CRMDOUser	loadByUsername(java.lang.String username, java.util.ArrayList<java.lang.String> associations) Loads a user based on a username.
java.lang.String	loadPassword(com.crm.dataobject.users.CRMDOUser user) Loads the user password from the e-center.
java.lang.Boolean	userExtensionExists(java.lang.String agentExtension) Checks if the given phone extension exists
void	validateIsCTIEnabledOnSave(com.crm.dataobject.users.CRMDOUser user) Validates if CTI is enabled on save.
void	validatePassword(com.crm.dataobject.users.CRMDOUser user) Validates the password of a user.
void	validateUsername(com.crm.dataobject.users.CRMDOUser user) Validates the username of a user.
java.lang.Boolean	validateUserPassword(com.crm.dataobject.users.CRMDOUser user, java.lang.String password)

Methods inherited from class com.crm.businessobject.CRMBO

construct, construct, construct, construct, construct, construct, construct, construct, construct, createAndUpdate, delete, delete, delete, getDOName, getDOName, getNextSequenceNumber, getNextSequenceNumber, getNumberScheme, isAssignable, load, load, load, load, load, load, load, load, load, loadAll, loadAll, loadAll, loadAllEntityStatusDO, loadAllEntityStatusDO, loadDataObject, loadDataObject, loadDataObject, loadDataObjects, loadEntityCategoryDO, loadEntityCategoryDO, loadEntityDO, loadEntityDO, loadEntityStatusDO, loadEntityStatusDO, parseAssociations, parseAssociations, save, save, save, saveCRMDOCollection, saveImages, setMandatoryFields, setNumberScheme, validateAndDelete, validateAndSave, validateAndSave, validateAndSave, validateApprovalRequestEntity, validateFormatSettings, validateFormatSettings, validateOnDelete, validateOnDelete, validateOnDelete, validateOnSave, validateOnSave, validateOnSave

Methods inherited from class com.crm.businessobject.CRMBase

deepCopy, dispatch, getCRMSession, getCRMSessionHandle, getCurrentDate, getEJBHomeInterface, getInitialContext, getSessionContext, invoke, setCRMSessionHandle, setInitialContext, setSessionContext

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CRMBOUserBean

public CRMBOUserBean()

Default constructor.

Method Detail

validateUsername

public void validateUsername(com.crm.dataobject.users.CRMDOUser user)
                      throws java.lang.Exception,
                             com.crm.exception.businessnetwork.InvalidUsernameException

Validates the username of a user.

Parameters:

user - - the user to validate

Throws:

java.lang.Exception

com.crm.exception.businessnetwork.PasswordConfirmationException

com.crm.exception.businessnetwork.InvalidPasswordException

com.crm.exception.businessnetwork.InvalidUsernameException

validatePassword

public void validatePassword(com.crm.dataobject.users.CRMDOUser user)
                      throws java.lang.Exception,
                             com.crm.exception.businessnetwork.PasswordConfirmationException,
                             com.crm.exception.businessnetwork.InvalidPasswordException

Validates the password of a user.

Parameters:

user - - the user to validate

Throws:

java.lang.Exception

com.crm.exception.businessnetwork.PasswordConfirmationException

com.crm.exception.businessnetwork.InvalidPasswordException

validateIsCTIEnabledOnSave

public void validateIsCTIEnabledOnSave(com.crm.dataobject.users.CRMDOUser user)
                                throws java.lang.Exception

Validates if CTI is enabled on save.

Parameters:

user - - the user to validate

Throws:

java.lang.Exception

getDefaultAssociations

public java.util.ArrayList<java.lang.String> getDefaultAssociations()

Returns the default associated data objects of a user.

Specified by:

getDefaultAssociations in class CRMBO

Returns:

the default associated data objects of the user

initialize

public com.crm.dataobject.users.CRMDOUser initialize(com.crm.dataobject.users.CRMDOUser user,
                                                     com.crm.dataobject.users.CRMDOUserTemplate userTemplate)
                                              throws java.lang.Exception

Initializes a user from a user template.

Parameters:

user - - the user to initialize

userTemplate - - the user template to initialize from

Returns:

the initialized user

Throws:

java.lang.Exception

validateUserPassword

public java.lang.Boolean validateUserPassword(com.crm.dataobject.users.CRMDOUser user,
                                              java.lang.String password)
                                       throws java.lang.Exception

Throws:

java.lang.Exception

exists

public java.lang.Boolean exists(com.crm.dataobject.users.CRMDOUser user)
                         throws java.lang.Exception

Checks if the user exists in the database.

Parameters:

user - - the user to check

Returns:

true if the user exists in the database, false if not

Throws:

java.lang.Exception

loadPassword

public java.lang.String loadPassword(com.crm.dataobject.users.CRMDOUser user)
                              throws java.lang.Exception

Loads the user password from the e-center.

Parameters:

user - - the user to load the password from

Returns:

the user password

Throws:

java.lang.Exception

loadByUsername

public com.crm.dataobject.users.CRMDOUser loadByUsername(java.lang.String username)
                                                  throws java.lang.Exception

Loads a user based on a username.

Parameters:

username - - the name of the user

Returns:

a user with the given username

Throws:

java.lang.Exception

loadByUsername

public com.crm.dataobject.users.CRMDOUser loadByUsername(java.lang.String username,
                                                         java.util.ArrayList<java.lang.String> associations)
                                                  throws java.lang.Exception

Loads a user based on a username.

Parameters:

username - - the name of the user

associations - - a list of associated data objects

Returns:

a user with the given username

Throws:

java.lang.Exception

loadByEmail

public com.crm.dataobject.users.CRMDOUser loadByEmail(java.lang.String email,
                                                      java.util.ArrayList<java.lang.String> associations)
                                               throws java.lang.Exception

Loads a user based on an email address.

Parameters:

email - - a user email

associations - - a list of associated data objects

Returns:

the user with the given email address

Throws:

java.lang.Exception

load

public java.util.ArrayList<com.crm.dataobject.CRMDO> load(com.crm.dataobject.contactinfo.CRMDOContactInfoEmail contactInfoEmail)
                                                   throws java.lang.Exception

Loads a list of users based on a contact information email.

Parameters:

contactInfoEmail - - a contact information email

Returns:

a list of users with the given contact information email

Throws:

java.lang.Exception

load

public java.util.ArrayList<com.crm.dataobject.CRMDO> load(com.crm.dataobject.contactinfo.CRMDOContactInformation contactInformation)
                                                   throws java.lang.Exception

Loads a list of users based on a contact.

Parameters:

contactInformation - - a contact to load the user from

Returns:

a list of users with the given contact

Throws:

java.lang.Exception

load

public java.util.ArrayList load(com.crm.dataobject.securitymanagement.CRMDOSecurityProfile securityProfile,
                                java.lang.Boolean active)
                         throws java.lang.Exception

Loads a list of users (active and/or inactive) based on a security profile.

Parameters:

securityProfile - - the security profile to retrieve the users from

active - - a boolean indicating if the objects are active or inactive

Returns:

a list of active and/or inactive users with the given security profile

Throws:

java.lang.Exception

load

public java.util.ArrayList<com.crm.dataobject.CRMDO> load(com.crm.dataobject.networkmanagement.CRMDOCommunity community)
                                                   throws java.lang.Exception

Loads a list of user for a community

Parameters:

community - - a community data object

Returns:

a list of user units for the given community

Throws:

java.lang.Exception

load

public java.util.ArrayList<com.crm.dataobject.CRMDO> load(com.crm.dataobject.networkmanagement.CRMDOUnitGroup group)
                                                   throws java.lang.Exception

Loads a list of user for a group

Parameters:

group - - a group data object

Returns:

a list of user units for the given group

Throws:

java.lang.Exception

loadActive

public java.util.ArrayList<com.crm.dataobject.CRMDO> loadActive(com.crm.dataobject.securitymanagement.CRMDOSecurityProfile securityProfile)
                                                         throws java.lang.Exception

Throws:

java.lang.Exception

loadActiveWithEmail

public java.util.ArrayList<com.crm.dataobject.CRMDO> loadActiveWithEmail()
                                                                  throws java.lang.Exception

Throws:

java.lang.Exception

load

public java.util.ArrayList load(com.crm.dataobject.networkmanagement.CRMDOUnit unit)
                         throws java.lang.Exception

Loads a list of user for a unit

Parameters:

unit - - a unit data object

Returns:

a list of users for the given unit

Throws:

java.lang.Exception

getLockOutTimeStartDate

public java.util.Date getLockOutTimeStartDate(com.crm.dataobject.users.CRMDOUser user)
                                       throws java.lang.Exception

Returns the lock out start date period.

Parameters:

user - - the user to get the date

Returns:

the lock out time start date

Throws:

java.lang.Exception

isInLockOutPeriod

public java.lang.Boolean isInLockOutPeriod(com.crm.dataobject.users.CRMDOUser user)
                                    throws java.lang.Exception

Checks if a user is in lock out period.

Parameters:

user - - the user to check

Returns:

true if the user is in lockout period, false if not

Throws:

java.lang.Exception

cancelLockOutPeriod

public void cancelLockOutPeriod(com.crm.dataobject.users.CRMDOUser user)
                         throws java.lang.Exception

Updates the USERLOCKOUTTIME table.

Parameters:

user - - the user to update the related records

Throws:

java.lang.Exception

calculatePasswordExpirationDate

public java.util.Date calculatePasswordExpirationDate(com.crm.dataobject.users.CRMDOUser user)
                                               throws java.lang.Exception

Calculates the password expiration date of the given user

Parameters:

user - - the user to calculate its password expiration date

Returns:

the password expiration date of the user

Throws:

java.lang.Exception

userExtensionExists

public java.lang.Boolean userExtensionExists(java.lang.String agentExtension)
                                      throws java.lang.Exception

Checks if the given phone extension exists

Parameters:

agentExtension - - the agent extension to check if exists

Returns:

true if the extension exists, false if not

Throws:

java.lang.Exception