com.logicboxes.foundation.sfnb.user
Class Reseller

java.lang.Object
  extended by com.logicboxes.foundation.sfnb.user.Reseller

public class Reseller
extends java.lang.Object


Constructor Summary
Reseller()
           
 
Method Summary
 java.util.HashMap addReseller(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 sub_username, java.lang.String name, java.lang.String company, java.lang.String langpref, java.lang.String passwd, 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, int salesContactId, java.lang.String[] productIdArr, boolean futureProductSignup, java.lang.String accountingCurrencySymbol, java.lang.String sellingCurrencySymbol, java.lang.String referrerCode, java.lang.String requestheaders)
          Deprecated. 
 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 Reseller class.
 int authenticateReseller(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 sub_username, java.lang.String passwd)
          Authenticates sub-reseller
 java.util.HashMap authenticateResellerId(java.lang.String userName, java.lang.String password, java.lang.String role, java.lang.String langpref, int parentid, java.lang.String userLoginId)
          This method authenticates LoginID that is generated by 'login' method of Reseller class.
 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 resellerId)
          Creates temporary password for sub-reseller New password is created for security reasons .
 java.util.HashMap getDetails(java.lang.String SERVICE_USERNAME, java.lang.String SERVICE_PASSWORD, java.lang.String SERVICE_ROLE, java.lang.String SERVICE_LANGPREF, int SERVICE_PARENTID, int resellerId, java.util.Vector option)
          Returns order details of reseller depending upon various option values.
 java.util.HashMap getResellerActiveProductCategoryFromURL(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 brandedUrl, boolean includeAddDeniedProducts)
          This method returns the reseller active productcategories from brandedUrl The boolean parameter includeAddDeniedProducts decides whether to include the "Do Not Sell" productcategories in the return array.
 java.lang.String[] getResellerActiveProductsFromURL(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 brandedUrl, boolean includeAddDeniedProducts)
          This method returns the reseller active products from brandedUrl The boolean parameter includeAddDeniedProducts decides whether to include the "Do Not Sell" products in the return array.
 java.util.HashMap getResellerDetailsFromURL(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 brandedUrl, java.util.Vector option)
          Returns details of reseller from the specified brandedurl of the reseller.
 java.util.HashMap getResellerPromoDetails(java.lang.String userName, java.lang.String password, java.lang.String role, java.lang.String langpref, int parentid, java.lang.String resellerid)
          Returns the promo details of the reseller if eligible
 java.util.HashMap getResellerSupportPriorityAPI(java.lang.String userName, java.lang.String password, java.lang.String role, java.lang.String langpref, int parentid, java.lang.String emailAdd, java.lang.String passwd, int resellerid)
          Validate the credentials.
 java.util.HashMap getSalesContactList(java.lang.String SERVICE_USERNAME, java.lang.String SERVICE_PASSWORD, java.lang.String SERVICE_ROLE, java.lang.String SERVICE_LANGPREF, int SERVICE_PARENTID, int resellerId)
          Returns list of sales contact of specified reseller
 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[] subResellerId, java.lang.String sub_username, java.lang.String name, java.lang.String company, java.lang.String city, java.lang.String country, java.lang.String[] resellerStatus, 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 sub resellers and their details
 java.util.HashMap login(java.lang.String userName, java.lang.String password, java.lang.String role, java.lang.String langpref, int parentid, java.lang.String ipAddress, java.lang.String headers)
          This method generates loginID, which can be authenticated using authenticateResellerId 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, 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, java.lang.String brandName, java.lang.String websiteUrl)
           
 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, 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 brandName, java.lang.String websiteUrl)
          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 temporary password to email address of sub-reseller New password is created for security reasons .
 java.util.HashMap 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 sub_username, java.lang.String name, java.lang.String company, java.lang.String langpref, java.lang.String passwd, 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, int salesContactId, boolean futureProductSignup, java.lang.String accountingCurrencySymbol, java.lang.String sellingCurrencySymbol, java.lang.String requestheaders)
           
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Reseller

public Reseller()
Method Detail

createTemporaryPassword

public 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 resellerId)
Creates temporary password for sub-reseller New password is created for security reasons . This temporary password is valid for 3 days and customer will have two valid passwords. Sub-reseller can change original password by loging through temporary password.

Parameters:
resellerId - ResellerId of sub-reseller for which temporary password to be generated
Returns:
temporary password

authenticateReseller

public int authenticateReseller(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 sub_username,
                                java.lang.String passwd)
Authenticates sub-reseller

Parameters:
sub_username - Username of sub-reseller
passwd - Password of sub-reseller
Returns:
resellerId

modDetails

@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,
                                  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 brandName,
                                  java.lang.String websiteUrl)
Deprecated. 

modify details of sub reseller

Parameters:
userName - UserName of the sub reseller
name - Name of sub reseller
company - Name of the company
langpref - Language code for the language that reseller wants to see in the interface in. e.g. en for English Language.
address1 - Address line1
address2 - Address line2
address3 - Address line3
city - City
state - State
country - Country
zip - zipcode
telNoCc - telephone no country code e.g. 91
telNo - telephone no. e.g. 9892478335
altTelNoCc - alternate telephone no country code
altTelNo - alternate telephone no.
faxNoCc - fax no. country code
faxNo - fax no.
brandName - Brandname of subreseller
websiteUrl - Website url of sub reseller

getResellerDetailsFromURL

public java.util.HashMap getResellerDetailsFromURL(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 brandedUrl,
                                                   java.util.Vector option)
Returns details of reseller from the specified brandedurl of the reseller. Pass All if all details require

Parameters:
brandedUrl - brandedUrl of sub reseller
option - reseller can view details by All, Billing, Brand, Abuse, LimitedBrand, Profile, Funds, Main.
Returns:
hashtable with the details for that reseller

getSalesContactList

public java.util.HashMap getSalesContactList(java.lang.String SERVICE_USERNAME,
                                             java.lang.String SERVICE_PASSWORD,
                                             java.lang.String SERVICE_ROLE,
                                             java.lang.String SERVICE_LANGPREF,
                                             int SERVICE_PARENTID,
                                             int resellerId)
Returns list of sales contact of specified reseller

Parameters:
resellerId - resellerId of reseller
Returns:
HashMap with key-value parameters containing userid=>name of sales contact

getResellerPromoDetails

public java.util.HashMap getResellerPromoDetails(java.lang.String userName,
                                                 java.lang.String password,
                                                 java.lang.String role,
                                                 java.lang.String langpref,
                                                 int parentid,
                                                 java.lang.String resellerid)
Returns the promo details of the reseller if eligible

Parameters:
resellerid - : Resellerid of reseller
Returns:
HashMap with key-value pairs containing promo-number=>promodetails of all the promos the reseller is eligible for

authenticateResellerId

public java.util.HashMap authenticateResellerId(java.lang.String userName,
                                                java.lang.String password,
                                                java.lang.String role,
                                                java.lang.String langpref,
                                                int parentid,
                                                java.lang.String userLoginId)
This method authenticates LoginID that is generated by 'login' method of Reseller class. Method checks if the LoginID passed belongs to that Reseller.

Parameters:
userLoginId - - LoginID generated using Login method of Reseller class.
Returns:
Reseller Details if the loginID is authenticated.
Throws:
LogicBoxesException - If the loginID does not match with that reseller.

login

public java.util.HashMap login(java.lang.String userName,
                               java.lang.String password,
                               java.lang.String role,
                               java.lang.String langpref,
                               int parentid,
                               java.lang.String ipAddress,
                               java.lang.String headers)
This method generates loginID, which can be authenticated using authenticateResellerId method. Use this method if you want to maintain a history of reseller logins.

Parameters:
ipAddress - IP Address of the Reseller
headers - HTTP Header
Returns:
loginID
Throws:
SqlException
LogicBoxesException

getResellerSupportPriorityAPI

public java.util.HashMap getResellerSupportPriorityAPI(java.lang.String userName,
                                                       java.lang.String password,
                                                       java.lang.String role,
                                                       java.lang.String langpref,
                                                       int parentid,
                                                       java.lang.String emailAdd,
                                                       java.lang.String passwd,
                                                       int resellerid)
Validate the credentials. If it is valid for the reseller id or for internals user of reseller id then get summary of reseller from getResellerSummary of fund class and get priority from table using getPriorityFrmTable()

Parameters:
emailAdd - Email address of reseller id to authenticate Reseller
passwd - Password of reseller id to authenticate Reseller
resellerid - Reseller Id of the Reseller
Returns:
Returns a hashtable containing reseller fund details sucha sa total recipts, pending invoice/debit note amount etc along with priority of the reseller.
Throws:
LogicBoxesException

authenticateLoginID

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)
This method authenticates loginID generated by generateLoginID method of Reseller class. Method checks if the LoginID passed belongs to that Reseller. If it does returns the reseller details else will throw Exception

Parameters:
loginID - LoginID generated using generateLoginID() method of Reseller class.
Returns:
Reseller Details if the loginID is authenticated.
Throws:
LogicBoxesException

getResellerActiveProductsFromURL

public java.lang.String[] getResellerActiveProductsFromURL(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 brandedUrl,
                                                           boolean includeAddDeniedProducts)
This method returns the reseller active products from brandedUrl The boolean parameter includeAddDeniedProducts decides whether to include the "Do Not Sell" products in the return array. If true then products marked as "Do Not Sell" will be included in the return array otherwise not.

Parameters:
brandedUrl -
includeAddDeniedProducts -
Returns:
Returns the reseller's active products.
Throws:
LogicBoxesException

getResellerActiveProductCategoryFromURL

public java.util.HashMap getResellerActiveProductCategoryFromURL(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 brandedUrl,
                                                                 boolean includeAddDeniedProducts)
This method returns the reseller active productcategories from brandedUrl The boolean parameter includeAddDeniedProducts decides whether to include the "Do Not Sell" productcategories in the return array. If true then productcategories of the products marked as "Do Not Sell" will be included in the return array otherwise not.

Parameters:
brandedUrl -
includeAddDeniedProducts -
Returns:
Returns the reseller's product active categories.
Throws:
LogicBoxesException

getDetails

public java.util.HashMap getDetails(java.lang.String SERVICE_USERNAME,
                                    java.lang.String SERVICE_PASSWORD,
                                    java.lang.String SERVICE_ROLE,
                                    java.lang.String SERVICE_LANGPREF,
                                    int SERVICE_PARENTID,
                                    int resellerId,
                                    java.util.Vector option)
Returns order details of reseller depending upon various option values. Pass All if all details require

Parameters:
option - reseller can view details by All, Billing, Brand, Abuse, LimitedBrand, Profile, Funds, Main. All will display all the order details of the reseller
Returns:
hashtable with all the details for that reseller id

addReseller

@Deprecated
public java.util.HashMap addReseller(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 sub_username,
                                                java.lang.String name,
                                                java.lang.String company,
                                                java.lang.String langpref,
                                                java.lang.String passwd,
                                                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,
                                                int salesContactId,
                                                java.lang.String[] productIdArr,
                                                boolean futureProductSignup,
                                                java.lang.String accountingCurrencySymbol,
                                                java.lang.String sellingCurrencySymbol,
                                                java.lang.String referrerCode,
                                                java.lang.String requestheaders)
Deprecated. 

Adds new sub reseller

Parameters:
sub_username - UserName of the sub reseller
name - Name of sub reseller
company - Name of the company
langpref - Language code for the language that reseller wants to see in the interface in. e.g. en for English Language.
passwd - Password of sub reseller
address1 - Address line1
address2 - Address line2
address3 - Address line3
city - City
state - State
country - Country code i.e. IN for India
zip - zipcode
telNoCc - telephone no country code e.g. 91
telNo - telephone no. e.g. 9892478335
altTelNoCc - alternate telephone no country code
altTelNo - alternate telephone no.
faxNoCc - fax no. country code
faxNo - fax no.
salesContactId - SalesContactId. 0 if do not want to pass salesContactId
productIdArr - Comma separated list of productIds i.e. domorder
futureProductSignup - Whether user wants to signup automatically for future products i.e. true/false
accountingCurrencySymbol - Accounting currency symbol i.e. USD
sellingCurrencySymbol - Selling currency symbol i.e. USD
referrerCode - Username of referrer reseller
requestheaders - requestheaders
Returns:
Hashtable containing details of newly added reseller
Throws:
LogicBoxesException - if option value is null or Invalid SqlException if any Database related Exception occurs LogicBoxesException if any internal errors occur

list

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[] subResellerId,
                              java.lang.String sub_username,
                              java.lang.String name,
                              java.lang.String company,
                              java.lang.String city,
                              java.lang.String country,
                              java.lang.String[] resellerStatus,
                              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 sub resellers and their details

Parameters:
subResellerId - Resellerid of sub reseller
sub_username - UserName of the sub reseller
name - Name of sub reseller
company - Name of the company
city - City
country - Country i.e. IN
resellerStatus - Status of sub reseller i.e. Active, Suspended ect.
creationDtStart - Timestamp of creation date start range
creationDtEnd - Timestamp of creation date end range
totalReceiptStart - Start range of totalreceipt
totalReceiptEnd - End range of totalreceipt
noOfRecords - No of records per page, minimum value must be 10
pageNo - Page number i.e. 1
orderBy - Comma separated list of columns i.e. name,company
Returns:
Hashtable containing details of sub reseller
Throws:
LogicBoxesException - if option value is null or Invalid SqlException if any Database related Exception occurs LogicBoxesException if any internal errors occur

sendTemporaryPassword

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)
Sends temporary password to email address of sub-reseller New password is created for security reasons . This temporary password is valid for 3 days and reseller will have two valid passwords. Sub-reseller can change original password by loging through temporary password.

Parameters:
emailAddr - Email address of sub-reseller to whom temporary password to be sent
Returns:
true/false depending on password is being sent or not

signUp

public java.util.HashMap 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 sub_username,
                                java.lang.String name,
                                java.lang.String company,
                                java.lang.String langpref,
                                java.lang.String passwd,
                                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,
                                int salesContactId,
                                boolean futureProductSignup,
                                java.lang.String accountingCurrencySymbol,
                                java.lang.String sellingCurrencySymbol,
                                java.lang.String requestheaders)

mod

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,
                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,
                java.lang.String brandName,
                java.lang.String websiteUrl)