|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.logicboxes.foundation.sfnb.user.Customer
public class Customer
Constructor Summary | |
---|---|
Customer()
|
Method Summary | |
---|---|
int |
addCustomer(java.lang.String SERVICE_USERNAME,
java.lang.String SERVICE_PASSWORD,
java.lang.String SERVICE_ROLE,
java.lang.String SERVICE_LANGPREF,
int SERVICE_PARENTID,
java.lang.String customerUserName,
java.lang.String customerPassword,
java.lang.String name,
java.lang.String company,
java.lang.String address1,
java.lang.String address2,
java.lang.String address3,
java.lang.String city,
java.lang.String state,
java.lang.String country,
java.lang.String zip,
java.lang.String telNoCc,
java.lang.String telNo,
java.lang.String altTelNoCc,
java.lang.String altTelNo,
java.lang.String faxNoCc,
java.lang.String faxNo,
java.lang.String customerLangPref)
Deprecated. |
int |
authenticateCustomer(java.lang.String SERVICE_USERNAME,
java.lang.String SERVICE_PASSWORD,
java.lang.String SERVICE_ROLE,
java.lang.String SERVICE_LANGPREF,
int SERVICE_PARENTID,
java.lang.String username,
java.lang.String passwd)
Authenticates customer using his username and password |
java.util.HashMap |
authenticateCustomerId(java.lang.String SERVICE_USERNAME,
java.lang.String SERVICE_PASSWORD,
java.lang.String SERVICE_ROLE,
java.lang.String SERVICE_LANGPREF,
int SERVICE_PARENTID,
java.lang.String userLoginId)
This method authenticates LoginID that is generated by 'login' method of Customer class. |
java.util.HashMap |
authenticateLoginID(java.lang.String SERVICE_USERNAME,
java.lang.String SERVICE_PASSWORD,
java.lang.String SERVICE_ROLE,
java.lang.String SERVICE_LANGPREF,
int SERVICE_PARENTID,
java.lang.String loginID)
This method authenticates loginID generated by generateLoginID method of Customer class. |
void |
changePassword(java.lang.String SERVICE_USERNAME,
java.lang.String SERVICE_PASSWORD,
java.lang.String SERVICE_ROLE,
java.lang.String SERVICE_LANGPREF,
int SERVICE_PARENTID,
int customerId,
java.lang.String newPasswd)
Changes the password for the specified customer. |
java.lang.String |
createTemporaryPassword(java.lang.String SERVICE_USERNAME,
java.lang.String SERVICE_PASSWORD,
java.lang.String SERVICE_ROLE,
java.lang.String SERVICE_LANGPREF,
int SERVICE_PARENTID,
int customerId)
Creates new password for a customer who has forgotten the password. |
void |
delete(java.lang.String SERVICE_USERNAME,
java.lang.String SERVICE_PASSWORD,
java.lang.String SERVICE_ROLE,
java.lang.String SERVICE_LANGPREF,
int SERVICE_PARENTID,
int customerId)
Deletes a customer if there are no active orders. |
java.lang.String |
generateLoginID(java.lang.String SERVICE_USERNAME,
java.lang.String SERVICE_PASSWORD,
java.lang.String SERVICE_ROLE,
java.lang.String SERVICE_LANGPREF,
int SERVICE_PARENTID,
java.lang.String ipAddress)
This method generates LoginID for the Customer. |
int |
getCustomerId(java.lang.String SERVICE_USERNAME,
java.lang.String SERVICE_PASSWORD,
java.lang.String SERVICE_ROLE,
java.lang.String SERVICE_LANGPREF,
int SERVICE_PARENTID,
java.lang.String customerUsername)
This function returns the Customer id of an existing Customer. |
java.util.HashMap |
getDetailsByCustomerEmail(java.lang.String SERVICE_USERNAME,
java.lang.String SERVICE_PASSWORD,
java.lang.String SERVICE_ROLE,
java.lang.String SERVICE_LANGPREF,
int SERVICE_PARENTID,
java.lang.String username,
java.util.Vector option)
Returns complete details by using customer's email address |
java.util.HashMap |
getDetailsByCustomerId(java.lang.String SERVICE_USERNAME,
java.lang.String SERVICE_PASSWORD,
java.lang.String SERVICE_ROLE,
java.lang.String SERVICE_LANGPREF,
int SERVICE_PARENTID,
int customerId,
java.util.Vector option)
Returns complete details by using customerId for the specified Customer |
java.util.HashMap |
list(java.lang.String SERVICE_USERNAME,
java.lang.String SERVICE_PASSWORD,
java.lang.String SERVICE_ROLE,
java.lang.String SERVICE_LANGPREF,
int SERVICE_PARENTID,
int[] customerId,
int[] resellerId,
java.lang.String username,
java.lang.String name,
java.lang.String company,
java.lang.String city,
java.lang.String country,
java.lang.String[] customerStatus,
java.lang.String creationDtStart,
java.lang.String creationDtEnd,
java.lang.String totalReceiptStart,
java.lang.String totalReceiptEnd,
int noOfRecords,
int pageNo,
java.lang.String[] orderBy)
Lists all the customers under a particular reseller |
java.util.HashMap |
login(java.lang.String SERVICE_USERNAME,
java.lang.String SERVICE_PASSWORD,
java.lang.String SERVICE_ROLE,
java.lang.String SERVICE_LANGPREF,
int SERVICE_PARENTID,
java.lang.String ipAddress,
java.lang.String headers)
This method generates loginID, which can be authenticated using authenticateCustomerId method. |
void |
mod(java.lang.String SERVICE_USERNAME,
java.lang.String SERVICE_PASSWORD,
java.lang.String SERVICE_ROLE,
java.lang.String SERVICE_LANGPREF,
int SERVICE_PARENTID,
int customerId,
java.lang.String userName,
java.lang.String name,
java.lang.String company,
java.lang.String langpref,
java.lang.String address1,
java.lang.String address2,
java.lang.String address3,
java.lang.String city,
java.lang.String state,
java.lang.String country,
java.lang.String zip,
java.lang.String telNoCc,
java.lang.String telNo,
java.lang.String altTelNoCc,
java.lang.String altTelNo,
java.lang.String faxNoCc,
java.lang.String faxNo,
java.lang.String mobileNoCc,
java.lang.String mobileNo)
Used to modify the details of Customer |
void |
modDetails(java.lang.String SERVICE_USERNAME,
java.lang.String SERVICE_PASSWORD,
java.lang.String SERVICE_ROLE,
java.lang.String SERVICE_LANGPREF,
int SERVICE_PARENTID,
int customerId,
java.lang.String customerUserName,
java.lang.String name,
java.lang.String company,
java.lang.String langpref,
java.lang.String address1,
java.lang.String address2,
java.lang.String address3,
java.lang.String city,
java.lang.String state,
java.lang.String country,
java.lang.String zip,
java.lang.String telNoCc,
java.lang.String telNo,
java.lang.String altTelNoCc,
java.lang.String altTelNo,
java.lang.String faxNoCc,
java.lang.String faxNo)
Deprecated. |
boolean |
sendTemporaryPassword(java.lang.String SERVICE_USERNAME,
java.lang.String SERVICE_PASSWORD,
java.lang.String SERVICE_ROLE,
java.lang.String SERVICE_LANGPREF,
int SERVICE_PARENTID,
java.lang.String emailAddr)
Sends new temporary password to customer's email address. |
int |
signUp(java.lang.String SERVICE_USERNAME,
java.lang.String SERVICE_PASSWORD,
java.lang.String SERVICE_ROLE,
java.lang.String SERVICE_LANGPREF,
int SERVICE_PARENTID,
java.lang.String userName,
java.lang.String passwd,
java.lang.String name,
java.lang.String company,
java.lang.String address1,
java.lang.String address2,
java.lang.String address3,
java.lang.String city,
java.lang.String stateName,
java.lang.String country,
java.lang.String zip,
java.lang.String telNoCc,
java.lang.String telNo,
java.lang.String altTelNoCc,
java.lang.String altTelNo,
java.lang.String faxNoCc,
java.lang.String faxNo,
java.lang.String langpref,
java.lang.String mobileNoCc,
java.lang.String mobileNo)
Adds new customer |
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public Customer()
Method Detail |
---|
public boolean sendTemporaryPassword(java.lang.String SERVICE_USERNAME, java.lang.String SERVICE_PASSWORD, java.lang.String SERVICE_ROLE, java.lang.String SERVICE_LANGPREF, int SERVICE_PARENTID, java.lang.String emailAddr)
emailAddr
- customers emailaddress to which new password will be sent if the
customer forgets password.
LogicBoxesException
- if option value is null or Invalid
SqlException if any Database related Exception occurs
LogicBoxesException if any internal errors occurpublic java.lang.String createTemporaryPassword(java.lang.String SERVICE_USERNAME, java.lang.String SERVICE_PASSWORD, java.lang.String SERVICE_ROLE, java.lang.String SERVICE_LANGPREF, int SERVICE_PARENTID, int customerId)
customerId
- customer Id for which new password will be created
LogicBoxesException
- if option value is null or Invalid
SqlException if any Database related Exception occurs
LogicBoxesException if any internal errors occurpublic int getCustomerId(java.lang.String SERVICE_USERNAME, java.lang.String SERVICE_PASSWORD, java.lang.String SERVICE_ROLE, java.lang.String SERVICE_LANGPREF, int SERVICE_PARENTID, java.lang.String customerUsername)
customerUsername
- username for which customerId is to be returned
LogicBoxesException
- if option value is null or Invalid
SqlException if any Database related Exception occurs
LogicBoxesException if any internal errors occurpublic java.util.HashMap getDetailsByCustomerId(java.lang.String SERVICE_USERNAME, java.lang.String SERVICE_PASSWORD, java.lang.String SERVICE_ROLE, java.lang.String SERVICE_LANGPREF, int SERVICE_PARENTID, int customerId, java.util.Vector option)
customerId
- numeric customerId assigned to the customer.option
- the various details that are required for the Customer.
Valid entries are:
All
Profile
Others
LogicBoxesException
- if option value is null or Invalid
SqlException if any Database related Exception occurs
LogicBoxesException if any internal errors occurpublic java.util.HashMap getDetailsByCustomerEmail(java.lang.String SERVICE_USERNAME, java.lang.String SERVICE_PASSWORD, java.lang.String SERVICE_ROLE, java.lang.String SERVICE_LANGPREF, int SERVICE_PARENTID, java.lang.String username, java.util.Vector option)
username
- string email address of the customer.option
- the various details that are required for the Customer.
Valid entries are:
All
Profile
Others
LogicBoxesException
- if option value is null or Invalid
SqlException if any Database related Exception occurs
LogicBoxesException if any internal errors occurpublic int authenticateCustomer(java.lang.String SERVICE_USERNAME, java.lang.String SERVICE_PASSWORD, java.lang.String SERVICE_ROLE, java.lang.String SERVICE_LANGPREF, int SERVICE_PARENTID, java.lang.String username, java.lang.String passwd)
username
- username to be authenticatepasswd
- password to be authenticate (password should be min 6 digit)
LogicBoxesException
- if option value is null or Invalid
SqlException if any Database related Exception occurs
LogicBoxesException if any internal errors occurpublic java.util.HashMap authenticateCustomerId(java.lang.String SERVICE_USERNAME, java.lang.String SERVICE_PASSWORD, java.lang.String SERVICE_ROLE, java.lang.String SERVICE_LANGPREF, int SERVICE_PARENTID, java.lang.String userLoginId)
userLoginId
- - LoginID generated using Login method of Customer class.
LogicBoxesException
- If the loginID does not match with that customerpublic java.util.HashMap login(java.lang.String SERVICE_USERNAME, java.lang.String SERVICE_PASSWORD, java.lang.String SERVICE_ROLE, java.lang.String SERVICE_LANGPREF, int SERVICE_PARENTID, java.lang.String ipAddress, java.lang.String headers)
ipAddress
- IP Address of the Customerheaders
- HTTP Header
SqlException
LogicBoxesException
public java.util.HashMap authenticateLoginID(java.lang.String SERVICE_USERNAME, java.lang.String SERVICE_PASSWORD, java.lang.String SERVICE_ROLE, java.lang.String SERVICE_LANGPREF, int SERVICE_PARENTID, java.lang.String loginID)
loginID
- Temporarily valid LoginID generated using generateLoginID() method of Customer class.
LogicBoxesException
public java.lang.String generateLoginID(java.lang.String SERVICE_USERNAME, java.lang.String SERVICE_PASSWORD, java.lang.String SERVICE_ROLE, java.lang.String SERVICE_LANGPREF, int SERVICE_PARENTID, java.lang.String ipAddress)
ipAddress
- IP Address of the Customer
LogicBoxesException
public java.util.HashMap list(java.lang.String SERVICE_USERNAME, java.lang.String SERVICE_PASSWORD, java.lang.String SERVICE_ROLE, java.lang.String SERVICE_LANGPREF, int SERVICE_PARENTID, int[] customerId, int[] resellerId, java.lang.String username, java.lang.String name, java.lang.String company, java.lang.String city, java.lang.String country, java.lang.String[] customerStatus, java.lang.String creationDtStart, java.lang.String creationDtEnd, java.lang.String totalReceiptStart, java.lang.String totalReceiptEnd, int noOfRecords, int pageNo, java.lang.String[] orderBy)
customerId
- Array of CustomerIds whose details are to be listedresellerId
- Array of Sub - Reseller's Ids whose Customer's details are
to be listedusername
- The Customer userName
Does an exact search by default. For doing special searches
use the % wildcard character. Eg. %username%name
- The Name of the Customer
Does an exact search by default. For doing special searches
use the % wildcard character. Eg. %name%company
- CompanyName
Does an exact search by default. For doing special searches
use the % wildcard character. Eg. %company%city
- Citycountry
- Country Code i.e. IN for IndiacustomerStatus
- Possible Values are Active,SuspendedcreationDtStart
- UNIX TimeStamp (epoch) for listing Orders created after
creationDTRangStart(required field)creationDtEnd
- UNIX TimeStamp (epoch) for listing Orders created before
creationDTRangEnd (required field)totalReceiptStart
- Total Receipts start value in selling currency (required field)totalReceiptEnd
- Total Receipts end value in selling currency (required field)noOfRecords
- No. of Records to be returned. (required field) should be minimum 10pageNo
- page number to be displayed. (required field) i.e. 1orderBy
- Possible values are customer.customerid, customer.name,
customer.username, customer.company, customer.customerstatus
LogicBoxesException
- if option value is null or Invalid
SqlException if any Database related Exception occurs
LogicBoxesException if any internal errors occur@Deprecated public int addCustomer(java.lang.String SERVICE_USERNAME, java.lang.String SERVICE_PASSWORD, java.lang.String SERVICE_ROLE, java.lang.String SERVICE_LANGPREF, int SERVICE_PARENTID, java.lang.String customerUserName, java.lang.String customerPassword, java.lang.String name, java.lang.String company, java.lang.String address1, java.lang.String address2, java.lang.String address3, java.lang.String city, java.lang.String state, java.lang.String country, java.lang.String zip, java.lang.String telNoCc, java.lang.String telNo, java.lang.String altTelNoCc, java.lang.String altTelNo, java.lang.String faxNoCc, java.lang.String faxNo, java.lang.String customerLangPref)
customerUserName
- UserName of the customercustomerPassword
- Passwordname
- Name OF Customercompany
- Name Of the companyaddress1
- Address line1address2
- Address line2address3
- Address line3city
- Citystate
- Statecountry
- Country Code i.e. IN for Indiazip
- zipcodetelNoCc
- telephone no country code e.g. 91telNo
- telephone no. e.g. 9892478335altTelNoCc
- alternate telephone no country codealtTelNo
- alternate telephone no.faxNoCc
- fax no. country codefaxNo
- fax no.customerLangPref
- Language code for the language that customer wants to see in the
interface in. e.g. en for English Language
LogicBoxesException
- if option value is null or Invalid
SqlException if any Database related Exception occurs
LogicBoxesException if any internal errors occur@Deprecated public void modDetails(java.lang.String SERVICE_USERNAME, java.lang.String SERVICE_PASSWORD, java.lang.String SERVICE_ROLE, java.lang.String SERVICE_LANGPREF, int SERVICE_PARENTID, int customerId, java.lang.String customerUserName, java.lang.String name, java.lang.String company, java.lang.String langpref, java.lang.String address1, java.lang.String address2, java.lang.String address3, java.lang.String city, java.lang.String state, java.lang.String country, java.lang.String zip, java.lang.String telNoCc, java.lang.String telNo, java.lang.String altTelNoCc, java.lang.String altTelNo, java.lang.String faxNoCc, java.lang.String faxNo)
customerId
- The Customer whose details are to be modified.customerUserName
- UserName of the customername
- Name of the customercompany
- company namelangpref
- language Prefrence i.e. language code e.g. en for Englishaddress1
- address line1address2
- address line2address3
- address line3city
- citystate
- statecountry
- country code i.e. IN for Indiazip
- zipcodetelNoCc
- country code for telephone number i.e. 91 for IndiatelNo
- telephone numberaltTelNoCc
- country code for alternate telephone no.altTelNo
- alternate telephone no.faxNoCc
- country code for fax no.faxNo
- fax no.
LogicBoxesException
- if option value is null or Invalid
SqlException if any Database related Exception occurs
LogicBoxesException if any internal errors occurpublic void changePassword(java.lang.String SERVICE_USERNAME, java.lang.String SERVICE_PASSWORD, java.lang.String SERVICE_ROLE, java.lang.String SERVICE_LANGPREF, int SERVICE_PARENTID, int customerId, java.lang.String newPasswd)
customerId
- The Customer whose password is to be modified.newPasswd
- modified password. (password should be min 6 digit)
LogicBoxesException
- if option value is null or Invalid
SqlException if any Database related Exception occurs
LogicBoxesException if any internal errors occurpublic int signUp(java.lang.String SERVICE_USERNAME, java.lang.String SERVICE_PASSWORD, java.lang.String SERVICE_ROLE, java.lang.String SERVICE_LANGPREF, int SERVICE_PARENTID, java.lang.String userName, java.lang.String passwd, java.lang.String name, java.lang.String company, java.lang.String address1, java.lang.String address2, java.lang.String address3, java.lang.String city, java.lang.String stateName, java.lang.String country, java.lang.String zip, java.lang.String telNoCc, java.lang.String telNo, java.lang.String altTelNoCc, java.lang.String altTelNo, java.lang.String faxNoCc, java.lang.String faxNo, java.lang.String langpref, java.lang.String mobileNoCc, java.lang.String mobileNo)
userName
- UserName of the customerpasswd
- Passwordname
- Name OF Customercompany
- Name Of the companyaddress1
- Address line1address2
- Address line2address3
- Address line3city
- CitystateName
- Statecountry
- Countryzip
- zipcodetelNoCc
- telephone no country code e.g. 91telNo
- telephone no. e.g. 9892478335altTelNoCc
- alternate telephone no country codealtTelNo
- alternate telephone no.faxNoCc
- fax no. country codefaxNo
- fax no.langpref
- Language code for the language customer want to see in the
interface in. e.g. en for English Language.hmobileNoCc
- mobile no. country codemobileNo
- mobile no.
LogicBoxesException
public void mod(java.lang.String SERVICE_USERNAME, java.lang.String SERVICE_PASSWORD, java.lang.String SERVICE_ROLE, java.lang.String SERVICE_LANGPREF, int SERVICE_PARENTID, int customerId, java.lang.String userName, java.lang.String name, java.lang.String company, java.lang.String langpref, java.lang.String address1, java.lang.String address2, java.lang.String address3, java.lang.String city, java.lang.String state, java.lang.String country, java.lang.String zip, java.lang.String telNoCc, java.lang.String telNo, java.lang.String altTelNoCc, java.lang.String altTelNo, java.lang.String faxNoCc, java.lang.String faxNo, java.lang.String mobileNoCc, java.lang.String mobileNo)
customerId
- ID of CustomeruserName
- UserName of the customername
- Name of Customercompany
- Name of Companylangpref
- Language code for the language customer want to see in the
interface in. e.g. en for English Language.haddress1
- Address line1address2
- Address line2address3
- Address line3city
- Citystate
- Statecountry
- Countryzip
- zipcodetelNoCc
- telephone no country code e.g. 91telNo
- telephone no. e.g. 9892478335altTelNoCc
- alternate telephone no country codealtTelNo
- alternate telephone no.faxNoCc
- fax no. country codefaxNo
- fax no.mobileNoCc
- mobile no. country codemobileNo
- mobile no.
LogicBoxesException
public void delete(java.lang.String SERVICE_USERNAME, java.lang.String SERVICE_PASSWORD, java.lang.String SERVICE_ROLE, java.lang.String SERVICE_LANGPREF, int SERVICE_PARENTID, int customerId)
customerId
-
LogicBoxesException
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |