com.accela.aa.emse.dom

Class PublicUserScript

java.lang.Object

com.accela.aa.emse.dom.service.BaseAAScript

com.accela.aa.emse.dom.PublicUserScript

All Implemented Interfaces:

com.accela.aa.emse.dom.service.PublicUserScriptService, com.accela.aa.emse.dom.service.ScriptAble

public class PublicUserScript
extends com.accela.aa.emse.dom.service.BaseAAScript
implements com.accela.aa.emse.dom.service.PublicUserScriptService

 
 Accela Automation
 File: PublicUserScript.java
 
  Accela, Inc.
  Copyright (C): 2008-2013
 
 Description:
 The class is used to expose the EJB interface to EMSE script
 
 Notes:
 $Id: PublicUserScript.java 242973 2013-01-21 07:41:46Z ..\bruce.deng $
 
 Revision History
 <Date>,          <Who>,                    <What>
 2008-8-12                      winter.jiang                            Initial.
 
 

Constructor Summary

Constructors

Constructor and Description
PublicUserScript() Instantiates a new public user script.
PublicUserScript(java.lang.String serviceProviderCode, java.lang.String callerID)

Method Summary

Methods

Modifier and Type	Method and Description
ScriptResult	activatePublicUser(java.lang.String uuid) Activate User's Account by hyperlink within Account Verification Email.
ScriptResult	checkPublicUserAccountInAgency(com.accela.v360.publicuser.PublicUserModel puser) Check whether public user account in the Agency is valid.
ScriptResult	createPublicUser(com.accela.v360.publicuser.PublicUserModel publicUser) create the publicUser.
ScriptResult	createPublicUser(com.accela.v360.publicuser.PublicUserModel publicUser, com.accela.aa.aamain.people.LicenseModel[] licenseModels) Creates a public user with agency user and issues associated licenses.
ScriptResult	createPublicUserForAgency(com.accela.v360.publicuser.PublicUserModel publicUser) Insert a record into XPUBLICUSER_SERVPROV table.
ScriptResult	disablePublicUserAccount(com.accela.v360.publicuser.PublicUserModel puser, boolean disableAllAgencyAccounts) Disable public user account in the Agency, public user could not log into the Agency once his account is disabled in the Agency.
ScriptResult	editPublicUser(com.accela.v360.publicuser.PublicUserModel publicUser) edit the appropriate publicUser.
com.accela.aa.aamain.organization.DepartmentModel	getDepartmentModel() get an instance of DepartmentModel
com.accela.aa.aamain.people.LicenseModel	getLicenseModel() get an instance of LicenseModel
java.lang.String	getNewPublicUserUUID() Get an next UUID for new public user.
ScriptResult	getOrganizatonOwner(com.accela.aa.aamain.organization.DepartmentModel organization) Get organization owner with organization model, .
ScriptResult	getPublicUser(java.lang.Long userSeqNum) get a publicUser record.
ScriptResult	getPublicUserByEmail(java.lang.String email) Gets a publicUser model by email address.
ScriptResult	getPublicUserByPUser(java.lang.String puserUserName) getPublicUserByPUser.
ScriptResult	getPublicUserBySearchKeys(com.accela.v360.publicuser.PublicUserModel puser, com.accela.aa.aamain.people.PeopleModel peopleModel, boolean searchAllAgencies) Search public user by search keys.
ScriptResult	getPublicUserByUserId(java.lang.String userId) Gets a publicUser model by user ID.
ScriptResult	getPublicUserListByContactNBR(java.lang.Long contactNBR) Search public user by contact number.
ScriptResult	getPublicUserListByLicenseSeqNBR(java.lang.Long licenseNBR) Search public user by License SeqNB.
ScriptResult	getPublicUserListByOwnerNBR(java.lang.String ownerNBR) Search public user by owner number.
com.accela.v360.publicuser.PublicUserModel	getPublicUserModel() get an instance of PublicUserModel
ScriptResult	isExistingEmailID(java.lang.String userEmail) Check whether an Email id of public user exists in the table PUBLICUSER.
ScriptResult	isExistingUser(java.lang.String userID) check if a public user id exists in teh table PUBLICUSER.
ScriptResult	isRegisterred(java.lang.Long userSeqNum) Check if there is a record in XPUBLICUSER_SERVPROV table already.
ScriptResult	purgExpiredInactiveAccount() According to PURGE_EXPIRED_ACCOUNT_INTERVAL in ACA_CONFIGS standard choice, to purge all expired inactive accounts.
ScriptResult	removePublicUserInfoFromAgency(com.accela.v360.publicuser.PublicUserModel puser) For the aspect of privacy, public user can remove his profile from the Agency.
ScriptResult	resetPassword(java.lang.String userID) reset password for a public User.
ScriptResult	sendActivateEmail(com.accela.v360.publicuser.PublicUserModel publicUserModel, boolean isAgencyUser, boolean isActivated) It to send activate Email for ACA.
ScriptResult	sendHyperlinkActivateEmail(com.accela.v360.publicuser.PublicUserModel publicUserModel) This email send to citizen user when register a new account and the email option turn on.
ScriptResult	sendPasswordEmail(com.accela.v360.publicuser.PublicUserModel publicUserModel) Sends new password Email for ACA.
ScriptResult	signon(java.lang.String userId, java.lang.String password) Find the agency id for the public user signon.
ScriptResult	updateEmail4PublicUser(com.accela.v360.publicuser.PublicUserModel puser, java.lang.String oldEmail) Update public user information when his email address is changed.

Methods inherited from class com.accela.aa.emse.dom.service.BaseAAScript

initScript

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.accela.aa.emse.dom.service.ScriptAble

initScript

Constructor Detail

PublicUserScript

public PublicUserScript(java.lang.String serviceProviderCode,
                java.lang.String callerID)
                 throws com.accela.aa.exception.AAException

Throws:

com.accela.aa.exception.AAException

PublicUserScript

public PublicUserScript()
                 throws com.accela.aa.exception.AAException

Instantiates a new public user script.

Throws:

com.accela.aa.exception.AAException - the AA exception

Method Detail

getPublicUserModel

public com.accela.v360.publicuser.PublicUserModel getPublicUserModel()

Description copied from interface: com.accela.aa.emse.dom.service.PublicUserScriptService

get an instance of PublicUserModel

Specified by:

getPublicUserModel in interface com.accela.aa.emse.dom.service.PublicUserScriptService

Returns:

PublicUserModel

getDepartmentModel

public com.accela.aa.aamain.organization.DepartmentModel getDepartmentModel()

Description copied from interface: com.accela.aa.emse.dom.service.PublicUserScriptService

get an instance of DepartmentModel

Specified by:

getDepartmentModel in interface com.accela.aa.emse.dom.service.PublicUserScriptService

Returns:

DepartmentModel

getLicenseModel

public com.accela.aa.aamain.people.LicenseModel getLicenseModel()

Description copied from interface: com.accela.aa.emse.dom.service.PublicUserScriptService

get an instance of LicenseModel

Specified by:

getLicenseModel in interface com.accela.aa.emse.dom.service.PublicUserScriptService

Returns:

LicenseModel

getNewPublicUserUUID

public java.lang.String getNewPublicUserUUID()

Get an next UUID for new public user.

Returns:

UUID.

createPublicUser

public ScriptResult createPublicUser(com.accela.v360.publicuser.PublicUserModel publicUser)

Description copied from interface: com.accela.aa.emse.dom.service.PublicUserScriptService

create the publicUser.

Specified by:

createPublicUser in interface com.accela.aa.emse.dom.service.PublicUserScriptService

Returns:

senquence number of the new Record

createPublicUser

public ScriptResult createPublicUser(com.accela.v360.publicuser.PublicUserModel publicUser,
                            com.accela.aa.aamain.people.LicenseModel[] licenseModels)

Description copied from interface: com.accela.aa.emse.dom.service.PublicUserScriptService

Creates a public user with agency user and issues associated licenses.

Specified by:

createPublicUser in interface com.accela.aa.emse.dom.service.PublicUserScriptService

Parameters:

publicUser - public user model

licenseModels - associated license models

Returns:

senquence number of the new Record

editPublicUser

public ScriptResult editPublicUser(com.accela.v360.publicuser.PublicUserModel publicUser)

Description copied from interface: com.accela.aa.emse.dom.service.PublicUserScriptService

edit the appropriate publicUser.

Specified by:

editPublicUser in interface com.accela.aa.emse.dom.service.PublicUserScriptService

Returns:

void

resetPassword

public ScriptResult resetPassword(java.lang.String userID)

Description copied from interface: com.accela.aa.emse.dom.service.PublicUserScriptService

reset password for a public User.

Specified by:

resetPassword in interface com.accela.aa.emse.dom.service.PublicUserScriptService

Returns:

the reset password (the new password)

isExistingUser

public ScriptResult isExistingUser(java.lang.String userID)

Description copied from interface: com.accela.aa.emse.dom.service.PublicUserScriptService

check if a public user id exists in teh table PUBLICUSER.

Specified by:

isExistingUser in interface com.accela.aa.emse.dom.service.PublicUserScriptService

Returns:

the senquence number of the found user

isExistingEmailID

public ScriptResult isExistingEmailID(java.lang.String userEmail)

Check whether an Email id of public user exists in the table PUBLICUSER.

Parameters:

userEmail - Register User Email.

Returns:

the sequence number of the found user

getPublicUser

public ScriptResult getPublicUser(java.lang.Long userSeqNum)

get a publicUser record.

Specified by:

getPublicUser in interface com.accela.aa.emse.dom.service.PublicUserScriptService

Parameters:

userSeqNum -

Returns:

PublicUserModel

getOrganizatonOwner

public ScriptResult getOrganizatonOwner(com.accela.aa.aamain.organization.DepartmentModel organization)

Description copied from interface: com.accela.aa.emse.dom.service.PublicUserScriptService

Get organization owner with organization model, .

Specified by:

getOrganizatonOwner in interface com.accela.aa.emse.dom.service.PublicUserScriptService

Returns:

PublicUserModel

createPublicUserForAgency

public ScriptResult createPublicUserForAgency(com.accela.v360.publicuser.PublicUserModel publicUser)

Description copied from interface: com.accela.aa.emse.dom.service.PublicUserScriptService

Insert a record into XPUBLICUSER_SERVPROV table.

Specified by:

createPublicUserForAgency in interface com.accela.aa.emse.dom.service.PublicUserScriptService

Returns:

void

signon

public ScriptResult signon(java.lang.String userId,
                  java.lang.String password)

Description copied from interface: com.accela.aa.emse.dom.service.PublicUserScriptService

Find the agency id for the public user signon.

Specified by:

signon in interface com.accela.aa.emse.dom.service.PublicUserScriptService

Returns:

a collection of user senquence number which match the userId+password

getPublicUserBySearchKeys

public ScriptResult getPublicUserBySearchKeys(com.accela.v360.publicuser.PublicUserModel puser,
                                     com.accela.aa.aamain.people.PeopleModel peopleModel,
                                     boolean searchAllAgencies)

Description copied from interface: com.accela.aa.emse.dom.service.PublicUserScriptService

Search public user by search keys.

Specified by:

getPublicUserBySearchKeys in interface com.accela.aa.emse.dom.service.PublicUserScriptService

Parameters:

puser - The PublicUser model which contains search keys.

peopleModel - The People model which contains search keys.

searchAllAgencies - Whether the public users in all Agencies.

Returns:

The public user collection searched by keys.

disablePublicUserAccount

public ScriptResult disablePublicUserAccount(com.accela.v360.publicuser.PublicUserModel puser,
                                    boolean disableAllAgencyAccounts)

Description copied from interface: com.accela.aa.emse.dom.service.PublicUserScriptService

Disable public user account in the Agency, public user could not log into the Agency once his account is disabled in the Agency.

Specified by:

disablePublicUserAccount in interface com.accela.aa.emse.dom.service.PublicUserScriptService

Parameters:

puser - The public user to be disabled in the Agency.

disableAllAgencyAccounts - Whether disable all Agency accounts.

Returns:

void

checkPublicUserAccountInAgency

public ScriptResult checkPublicUserAccountInAgency(com.accela.v360.publicuser.PublicUserModel puser)

Description copied from interface: com.accela.aa.emse.dom.service.PublicUserScriptService

Check whether public user account in the Agency is valid.

Specified by:

checkPublicUserAccountInAgency in interface com.accela.aa.emse.dom.service.PublicUserScriptService

Parameters:

puser - The public user to be checked.

Returns:

Returns true if the user's STATUS is "A", returns false if STATUS is "I".

removePublicUserInfoFromAgency

public ScriptResult removePublicUserInfoFromAgency(com.accela.v360.publicuser.PublicUserModel puser)

Description copied from interface: com.accela.aa.emse.dom.service.PublicUserScriptService

For the aspect of privacy, public user can remove his profile from the Agency.

Specified by:

removePublicUserInfoFromAgency in interface com.accela.aa.emse.dom.service.PublicUserScriptService

Parameters:

puser - The public user whose profile will be removed.

Returns:

void

updateEmail4PublicUser

public ScriptResult updateEmail4PublicUser(com.accela.v360.publicuser.PublicUserModel puser,
                                  java.lang.String oldEmail)

Description copied from interface: com.accela.aa.emse.dom.service.PublicUserScriptService

Update public user information when his email address is changed. The update will includes in G3STAFFS and CAP 's Contact tables.

Specified by:

updateEmail4PublicUser in interface com.accela.aa.emse.dom.service.PublicUserScriptService

Parameters:

puser - The public user model to be updated.

oldEmail - Public user's old email address.

Returns:

void

isRegisterred

public ScriptResult isRegisterred(java.lang.Long userSeqNum)

Description copied from interface: com.accela.aa.emse.dom.service.PublicUserScriptService

Check if there is a record in XPUBLICUSER_SERVPROV table already.

Specified by:

isRegisterred in interface com.accela.aa.emse.dom.service.PublicUserScriptService

Returns:

return true if the userSeqNum is registerrd, otherwise return false.

sendActivateEmail

public ScriptResult sendActivateEmail(com.accela.v360.publicuser.PublicUserModel publicUserModel,
                             boolean isAgencyUser,
                             boolean isActivated)

Description copied from interface: com.accela.aa.emse.dom.service.PublicUserScriptService

It to send activate Email for ACA.

Specified by:

sendActivateEmail in interface com.accela.aa.emse.dom.service.PublicUserScriptService

Returns:

void

sendHyperlinkActivateEmail

public ScriptResult sendHyperlinkActivateEmail(com.accela.v360.publicuser.PublicUserModel publicUserModel)
                                        throws com.accela.aa.exception.AAException

This email send to citizen user when register a new account and the email option turn on. And citizen user can activate his account by the hyperlink within the email.

Parameters:

publicUserModel - Public User Model.

Returns:

ScriptResult model.

Throws:

com.accela.aa.exception.AAException

getPublicUserByEmail

public ScriptResult getPublicUserByEmail(java.lang.String email)

Gets a publicUser model by email address.

Specified by:

getPublicUserByEmail in interface com.accela.aa.emse.dom.service.PublicUserScriptService

Parameters:

email - email address

Returns:

Public User Model

getPublicUserByUserId

public ScriptResult getPublicUserByUserId(java.lang.String userId)

Description copied from interface: com.accela.aa.emse.dom.service.PublicUserScriptService

Gets a publicUser model by user ID.

Specified by:

getPublicUserByUserId in interface com.accela.aa.emse.dom.service.PublicUserScriptService

Parameters:

userId - user ID

Returns:

Public User Model

sendPasswordEmail

public ScriptResult sendPasswordEmail(com.accela.v360.publicuser.PublicUserModel publicUserModel)

Description copied from interface: com.accela.aa.emse.dom.service.PublicUserScriptService

Sends new password Email for ACA.

Specified by:

sendPasswordEmail in interface com.accela.aa.emse.dom.service.PublicUserScriptService

Parameters:

publicUserModel - the public user model

Returns:

the script result

getPublicUserByPUser

public ScriptResult getPublicUserByPUser(java.lang.String puserUserName)

Description copied from interface: com.accela.aa.emse.dom.service.PublicUserScriptService

getPublicUserByPUser.

Specified by:

getPublicUserByPUser in interface com.accela.aa.emse.dom.service.PublicUserScriptService

Parameters:

puserUserName - the puser user name

Returns:

PublicUserModel

purgExpiredInactiveAccount

public ScriptResult purgExpiredInactiveAccount()

Description copied from interface: com.accela.aa.emse.dom.service.PublicUserScriptService

According to PURGE_EXPIRED_ACCOUNT_INTERVAL in ACA_CONFIGS standard choice, to purge all expired inactive accounts.

Specified by:

purgExpiredInactiveAccount in interface com.accela.aa.emse.dom.service.PublicUserScriptService

Returns:

ScriptResult true/false

getPublicUserListByLicenseSeqNBR

public ScriptResult getPublicUserListByLicenseSeqNBR(java.lang.Long licenseNBR)

Description copied from interface: com.accela.aa.emse.dom.service.PublicUserScriptService

Search public user by License SeqNB.

Specified by:

getPublicUserListByLicenseSeqNBR in interface com.accela.aa.emse.dom.service.PublicUserScriptService

Parameters:

licenseNBR - the license nbr

Returns:

the public user list by license seq nbr

getPublicUserListByContactNBR

public ScriptResult getPublicUserListByContactNBR(java.lang.Long contactNBR)

Search public user by contact number.

Parameters:

contactNBR - Contact Number.

Returns:

ScriptResult Object.

getPublicUserListByOwnerNBR

public ScriptResult getPublicUserListByOwnerNBR(java.lang.String ownerNBR)

Search public user by owner number.

Parameters:

ownerNBR - Owner Number.

Returns:

ScriptResult Object.

activatePublicUser

public ScriptResult activatePublicUser(java.lang.String uuid)

Activate User's Account by hyperlink within Account Verification Email.

Parameters:

uuid - Universally Unique Identifier for public user verification.

Returns:

ScriptResult Object.