//******************************************************************* // // Name: CustomerMaintenance.idl // // Description: // The class defines the interface for customer maintenance // object. // // Bugs: // // See also: // // Type: C++ header // //******************************************************************* #ifndef __CUSTOMERMAINTENANCE_IDL #define __CUSTOMERMAINTENANCE_IDL #include "TransactionManager.idl" #include "CorbaDof.idl" interface CorbaCustomerMaintenance { //******************************************************************* //******************************************************************* // // C U S T O M E R f u n c t i o n s // //******************************************************************* //******************************************************************* //******************************************************************* // Function : CreateCustomer // // Description: // Registering Customer in the system. The customer is created // with prospective status. // // Parameters: // Input: // tSecurity - A security tuple that is used to identify the // user of this function. Must contain 'UserId' // element containing a valid CSR user name. // hConnection - Database connection. Pass -1 if no connection // in use. // CustomerOid - Customer object identifier - the object type // should be initiated before creation and the // object number will be initiated in the function. // tCustomer - The customer's data to create. // The mandatory fields are: // Market object number. // Payment Method. // Credit Class obj number (*) // Customer status: // valid values are: // Active. (=1) // Suspended. (=2) // Prospect. (=3) // Canceled. (=4) // Closed. (=5) // Customer Type: // valid values are: // Regular. (=1) // Reseller. (=2) // Corporate. (=4) // Object Type: // valid values are: // Regular. (= 522) // Reseller. (= 504) // Corporate. (= 503) // If the billing event is not specified then // the closest date to the creation will be chosen. // The additional mandatory fields for Corporate Customer // are: // Root Corporate - The identifier of the corporate // root customer. // Son Of Obj Num - The identifier of the father // customer in the hierarchy. // Customer Level - A number that represent the level // in the hierarchy. // The additional mandatory fields for Reseller Customer // are: // Contract Service Number - The service object // number of the // reseller's contract. // Input Output: // CustomerOid - The identifier of Customer. The object number // passed empty and returned of the created // obejct. // Output: // sErrorMsg - Error message where applicable. // // // Returns: // false - Failure. // true - Success. //******************************************************************* boolean CreateCustomer(in CorbaDof::Tuple tSecurity, in TransactionManager::HCONNECTION hConnection, inout CorbaDof::OID CustomerOid, in CorbaDof::Tuple tCustomer, out string sErrorMsg); //******************************************************************* // Function : GetCustomer // // Description: // Get a customer's details from the database. // // Parameters: // Input: // hConnection - Database connection. Pass -1 if no connection // in use. // CustomerOid - The identifier of Customer. // Output: // tCustomer - The customer's details from the database. // sErrorMsg - Error message where applicable. // // // Returns: // false - Failure. // true - Success. //******************************************************************* boolean GetCustomer(in TransactionManager::HCONNECTION hConnection, in CorbaDof::OID CustomerOid, out CorbaDof::Tuple tCustomer, out string sErrorMsg); //******************************************************************* // Function : GetCustomerList // // Description: // Search for customers with parameters. // // Parameters: // Input: // hConnection - Database connection. Pass -1 if no connection // in use. // tSearchTuple - A tuple containing customer searching parameters. // llStartRow - The row to start fetching objects from. // lNumRows - The number of rows to fetch. If ALL_ROWS, then // all rows will be fetched. // Output: // tlCustomer - List of customers. // sErrorMsg - Error message where applicable. // // // Returns: // false - Failure. // true - Success. //******************************************************************* boolean GetCustomerList(in TransactionManager::HCONNECTION hConnection, in CorbaDof::Tuple tSearchTuple, in long long llStartRow, in long lNumRows, out CorbaDof::TupleList tlCustomer, out string sErrorMsg); // Delete customer. boolean DeleteCustomer(in CorbaDof::Tuple tSecurity, in CorbaDof::OID CustomerOid, out string sErrorMsg); //******************************************************************* // Function : UpdateCustomer // // Description: // Update customer details. // // Parameters: // Input: // tSecurity - A security tuple that is used to identify the // user of this function. Must contain 'UserId' // element containing a valid CSR user name. // hConnection - Database connection. Pass -1 if no connection // in use. // CustomerOid - The identifier of Customer. // tCustomer - The customer's details to update in the // database. Some of the details cannot be changed // using this function but special functions: // - Customer status // - Customer type // - Customer billing event // - Reseller contract service // - Corporate billing indicator // - Customer market // - Customer payment method // Output: // sErrorMsg - Error message where applicable. // // // Returns: // false - Failure. // true - Success. //******************************************************************* boolean UpdateCustomer(in CorbaDof::Tuple tSecurity, in TransactionManager::HCONNECTION hConnection, in CorbaDof::OID CustomerOid, in CorbaDof::Tuple tCustomer, out string sErrorMsg); //******************************************************************* // Function : UpdateCustomerBackdated // // Description: // Update customer backdated details (same as the UpdateCustomer) with additional data. // // Parameters: // Input: // tSecurity - A security tuple that is used to identify the // user of this function. Must contain 'UserId' // element containing a valid CSR user name. // hConnection - Database connection. Pass -1 if no connection // in use. // CustomerOid - The identifier of Customer. // tCustomer - The customer's details to update in the // database. Some of the details cannot be changed // using this function but special functions: // tOperationData - Operation Data like UserId and Reason of change anf effective date // range of the operation // Output: // sErrorMsg - Error message where applicable. // // // Returns: // false - Failure. // true - Success. //******************************************************************* boolean UpdateCustomerBackdated(in CorbaDof::Tuple tSecurity, in TransactionManager::HCONNECTION hConnection, in CorbaDof::OID CustomerOid, in CorbaDof::Tuple tCustomer, in CorbaDof::Tuple tOperationData, out string sErrorMsg); // Purge Customer from the system. boolean PurgeCustomer(in CorbaDof::Tuple tSecurity, in CorbaDof::OID CustomerOid, out string sErrorMsg); //******************************************************************* // Function : SetCustStatus // // Description: // Set a customer's status. // // Parameters: // Input: // tSecurity - A security tuple that is used to identify the // user of this function. Must contain 'UserId' // element containing a valid CSR user name. // hConnection - Database connection. Pass -1 if no connection // in use. // CustomerOid - The identifier of Customer. // sCustStatus - The customer's status to set. // Valid status values are: // Active. (=1) // Suspended. (=2) // Prospect. (=3) // Canceled. (=4) // Closed. (=5) // sReason - Reason description of customer status change. // Output: // sErrorMsg - Error message where applicable. // // // Returns: // false - Failure. // true - Success. //******************************************************************* boolean SetCustStatus(in CorbaDof::Tuple tSecurity, in TransactionManager::HCONNECTION hConnection, in CorbaDof::OID CustomerOid, in short CustStatus, in string sReason, out string sErrorMsg); // Set Customer market. boolean SetCustMarket(in CorbaDof::Tuple tSecurity, in CorbaDof::OID CustomerOid, in CorbaDof::OID MarketOid, out string sErrorMsg); //******************************************************************* // Function : SetBillingEvent // // Description: // Set a customer's billing cycle event. // // Parameters: // Input: // tSecurity - A security tuple that is used to identify the // user of this function. // hConnection - Database connection. Pass -1 if no connection // in use. // CustomerOid - The identifier of Customer. // BillingEventOid - The customer's billing cycle event to set. // Output: // sErrorMsg - Error message where applicable. // // // Returns: // false - Failure. // true - Success. //******************************************************************* boolean SetBillingEvent(in CorbaDof::Tuple tSecurity, in TransactionManager::HCONNECTION hConnection, in CorbaDof::OID CustomerOid, in CorbaDof::OID BillingEventOid, out string sErrorMsg); // Get customer history. boolean GetCustHistory(in CorbaDof::OID CustomerOid, out CorbaDof::TupleList tlCustHistoryList, out string sErrorMsg); //******************************************************************* // Function : SetBillingEventExtid // // Description: // Set a customer's billing cycle event. // // Parameters: // Input: // tSecurity - A security tuple that is used to identify the // user of this function. // hConnection - Database connection. Pass -1 if no connection // in use. // CustomerOid - The identifier of Customer. // sBillingEventExtId - The customer's billing event cycle event to set. // Output: // sErrorMsg - Error message where applicable. // // // Returns: // false - Failure. // true - Success. //******************************************************************* boolean SetBillingEventExtId(in CorbaDof::Tuple tSecurity, in TransactionManager::HCONNECTION hConnection, in CorbaDof::OID CustomerOid, in string sBillingEventExtId, out string sErrorMsg); //******************************************************************* // Function : ChangePaymentMethod // // Description: // Change payment method and payment details. // // Parameters: // Input: // tSecurity - A security tuple that is used to identify // the user of this function. // hConnection - Database connection. Pass -1 if no connection // in use. // CustomerOid - The identifier of Customer. // PaymentMethodOid - The customer's payment method identifier // to set. // tPaymentDetails - The customer's payment details to set // (optional). The payment details should // correspond the new payment method. // Output: // sErrorMsg - Error message where applicable. // // // Returns: // false - Failure. // true - Success. //******************************************************************* boolean ChangePaymentMethod(in CorbaDof::Tuple tSecurity, in TransactionManager::HCONNECTION hConnection, in CorbaDof::OID CustomerOid, in CorbaDof::OID PaymentMethodOid, in CorbaDof::Tuple tPaymentDetails, out string sErrorMsg); // Create CSR service for new customer. boolean CreateCSRService(in CorbaDof::Tuple tSecurity, in TransactionManager::HCONNECTION hConnection, in CorbaDof::OID CustomerOid, in CorbaDof::Tuple tAvl, out string sErrorMsg); // Update CSR service. boolean UpdateCSRService(in CorbaDof::Tuple tSecurity, in TransactionManager::HCONNECTION hConnection, in CorbaDof::OID CustomerOid, in CorbaDof::Tuple tAvl, out string sErrorMsg); //******************************************************************* // Function : Invoice // // Description: // Create an invoice with the current timestamp for a customer. // // Parameters: // Input: // tSecurity - A security tuple that is used to identify // the user of this function. // hConnection - Database connection. Pass -1 if no connection // in use. // CustomerOid - The identifier of Customer. // Output: // sErrorMsg - Error message where applicable. // // // Returns: // false - Failure. // true - Success. //******************************************************************* boolean Invoice(in CorbaDof::Tuple tSecurity, in TransactionManager::HCONNECTION hConnection, in CorbaDof::OID CustomerOid, out string sErrorMsg); //******************************************************************* // Function : LocateByOql // // Description: // Locate customers by executing an OQL statement. // // Parameters: // Input: // hConnection - Database connection. Pass -1 if no connection // in use. // sOQL - The OQL statement to execute. // OQL statement is very similar to SQL, // but uses Objects instead of DB tables. // tParams - The tuple containing customer searching // parameters. // llStartRow - The row to start fetching customers from // (0 - start with the first customer in DB). // iNumRows - The number of rows to fetch. // (0 - return full customer list). // Output: // tlCustomers - List of cutomers located by the OQL // statement. // sErrorMsg - Error message where applicable. // // // Returns: // false - Failure. // true - Success. //******************************************************************* boolean LocateByOql(in TransactionManager::HCONNECTION hConnection, in string sOQL, in CorbaDof::Tuple tParams, in long long llStartRow, in long iNumRows, out CorbaDof::TupleList tlCustomers, out string sErrorMsg); //******************************************************************* // Function : GetCustomerHierarchy // // Description: // CSM API that deals with getting the customer hierarchy. // The API receives the root node of the corporate and return // the corporate hierarchy. // The return value is a TupleList that include all the levels // requested by the user. // A Tuple list for each corporate level. // In a level of customers the corporate information will be // sorted by:CaptionFields // // Parameters: // Input: // RootCorporateID - The first node from where to start. // tCaptionFields - Which fields to add to the return // value to be presented. This will be a // tuple that include name of the fields // as value. // iLevels - How many levels to return. // lEffTime - The date for which the hierarchy data should be fetched // Output: // tlCorporateHirearchy - Return the coprporate in a recursive // TupleList. // sErrorMsg - Error message where applicable. // // // Returns: // false - Failure. // true - Success. //******************************************************************* boolean GetCustomerHierarchy(in TransactionManager::HCONNECTION hConnection, in CorbaDof::OID CustomerOid, in CorbaDof::Tuple tCaptionFields, in long iLevels, in long lEffTime, out CorbaDof::TupleList tlHierarchy, out string sErrorMsg); //******************************************************************* // Function : GetResellerCorporateHierarchy // // Description: // The API works the same way as the regular corporate hierarchy // except for bringing the required node and his child records as // long as they all registered for the same reseller. // // Parameters: // Input: // RootCorporateID - The first node from where to start. // tCaptionFields - Which fields to add to the return // value to be presented. This will be a // tuple that include name of the fields // as value. // iLevels - How many levels to return. // Output: // tlCorporateHirearchy - Return the coprporate in a recursive // TupleList. // sErrorMsg - Error message where applicable. // // // Returns: // false - Failure. // true - Success. //******************************************************************* boolean GetResellerHierarchy(in TransactionManager::HCONNECTION hConnection, in CorbaDof::OID CustomerOid, in CorbaDof::Tuple tCaptionFields, out CorbaDof::TupleList tlHierarchy, out string sErrorMsg); //******************************************************************* // Function : CreateSystemUser // // Description: // Registering Customer in the system. The customer is created // with prospective status. // // Parameters: // Input: // tSecurity - A security tuple that is used to identify the // user of this function. Must contain 'UserId' // element containing a valid CSR user name. // hConnection - Database connection. Pass -1 if no connection // in use. // tCustomer - The customer's data to create. // The mandatory fields are: // profile_name: the name of the required profile // main_password: the user password // main_user_name: the user name // Output: // CustomerOid - The identifier of Customer. The object number // passed empty and returned of the created // obejct. // Output: // sErrorMsg - Error message where applicable. // // // Returns: // false - Failure. // true - Success. //******************************************************************* boolean RegisterSystemUser(in CorbaDof::Tuple tSecurity, in TransactionManager::HCONNECTION hConnection, out CorbaDof::OID CustomerOid, in CorbaDof::Tuple tCustomer, out string sErrorMsg); //******************************************************************* // Function : GetCustProductsServices // // Description: // Get tree of customer products and services. Containing the // following fields:cust_product_oid, product_oid, product_name, // product_status, cust_product_name, service_oid, service_name, // cust_service_oid, cust_service_name, cust_service_status // // Parameters: // Input: // hConnection - Database connection. Pass -1 if no connection // in use. // SubscriberOid - The identifier of Subscriber. // Output: // tlResults - List of the customer products, products, services // and customer services. // sErrorMsg - Error message where applicable. // // Returns: // false - Failure. // true - Success. //******************************************************************* boolean GetCustProductsServices(in TransactionManager::HCONNECTION hConnection, in CorbaDof::OID CustomerOid, out CorbaDof::TupleList tlResults, out string sErrorMsg); //******************************************************************* // Function : RequestSuspend // // Description: // Set object suspension dates. // // Parameters: // Input: // tSecurity - A security tuple that is used to identify // the user of this function. // hConnection - Database connection. Pass -1 if no connection // in use. // theOid - The identifier of the Customer object. // tRequestData - The request dates data. // The fields: // suspend_eff_date - mandatory. // suspend_exp_date // num_of_days. // Output: // sErrorMsg - Error message where applicable. // // // Returns: // false - Failure. // true - Success. //******************************************************************* boolean RequestSuspend(in CorbaDof::Tuple tSecurity, in TransactionManager::HCONNECTION hConnection, in CorbaDof::OID theOid, in CorbaDof::Tuple tRequestData, out string sErrorMsg); //******************************************************************* // Function : ResetSuspend // // Description: // Reset the suspension request and clear the dates. // // Parameters: // Input: // tSecurity - A security tuple that is used to identify // the user of this function. // hConnection - Database connection. Pass -1 if no connection // in use. // theOid - The identifier of the Customer object. // Output: // sErrorMsg - Error message where applicable. // // // Returns: // false - Failure. // true - Success. //******************************************************************* boolean ResetSuspend(in CorbaDof::Tuple tSecurity, in TransactionManager::HCONNECTION hConnection, in CorbaDof::OID theOid, out string sErrorMsg); //******************************************************************* //******************************************************************* // // S U B S C R I B E R f u n c t i o n s // //******************************************************************* //******************************************************************* //******************************************************************* // Function : CreateSubscriber // // Description: // Create subscriber. // // Parameters: // Input: // tSecurity - A security tuple that is used to identify // the user of this function. // hConnection - Database connection. Pass -1 if no connection // in use. // SubscriberOid - The identifier of Customer product. The // object number passed as zero and returned // the new object number. // tSubscriber - The subscriber details to create in // the database. // The mandatory data fields: // Customer object number. // Subscriber id. // Registration date. // Status: // valid values are: // Active (= 1). // Suspended (= 2)· // Terminated (= 4). // - other information by the implementation. // Output: // sErrorMsg - Error message where applicable. // // // Returns: // false - Failure. // true - Success. //******************************************************************* boolean CreateSubscriber(in CorbaDof::Tuple tSecurity, in TransactionManager::HCONNECTION hConnection, inout CorbaDof::OID SubscriberOid, in CorbaDof::Tuple tSubscriber, out string sErrorMsg); //******************************************************************* // Function : CreateCustomerMainSubscriber // // Description: // Create customer main subscriber. Need less input than regular // subscriber since this is not a regular subscriber but subscriber // that holds all the customer level services. // // // Parameters: // Input: // tSecurity - A security tuple that is used to identify // the user of this function. // hConnection - Database connection. Pass -1 if no connection // in use. // CustomerOid - The identifier of Customer which the subscriber belongs to. // Output: // sErrorMsg - Error message where applicable. // // // Returns: // false - Failure. // true - Success. //******************************************************************* boolean CreateCustomerMainSubscriber(in CorbaDof::Tuple tSecurity, in TransactionManager::HCONNECTION hConnection, in CorbaDof::OID CustomerOid, out string sErrorMsg); //******************************************************************* // Function : GetSubscriber // // Description: // Get a subscriber's details from the database. // // Parameters: // Input: // hConnection - Database connection. Pass -1 if no connection // in use. // SubscriberOid - The identifier of Subscriber. // Output: // tSubscriber - The subscriber's details from the // database. // sErrorMsg - Error message where applicable. // // // Returns: // false - Failure. // true - Success. //******************************************************************* boolean GetSubscriber(in TransactionManager::HCONNECTION hConnection, in CorbaDof::OID SubscriberOid, out CorbaDof::Tuple tSubscriber, out string sErrorMsg); //******************************************************************* // Function : GetSubscriberList // // Description: // Search for subscribers with parameters. // Returns also "has_cust_product" (0 or 1) for each subscriber. // // Parameters: // Input: // hConnection - Database connection. Pass -1 if no connection // in use. // tSearchTuple - A tuple containing subscriber searching // parameters. // bOnlyActive - Get only subscribers with "Active" status. // Output: // tlSubscriber - List of subscribers. // Every Subscriber tuple include also: // * has_cust_product - whether the subscriber // has customer products (= 1). // sErrorMsg - Error message where applicable. // // // Returns: // false - Failure. // true - Success. //******************************************************************* boolean GetSubscriberList(in TransactionManager::HCONNECTION hConnection, in CorbaDof::Tuple tSearchTuple, in boolean bOnlyActive, out CorbaDof::TupleList tlSubscriber, out string sErrorMsg); //******************************************************************* // Function : UpdateSubscriber // // Description: // Update subscriber details. // // Parameters: // Input: // tSecurity - A security tuple that is used to identify // the user of this function. // hConnection - Database connection. Pass -1 if no connection // in use. // SubscriberOid - The identifier of Subscriber. // tSubscriber - The subscriber's details to update in the // database. The status field can not be // updated by this function. // Output: // sErrorMsg - Error message where applicable. // // // Returns: // false - Failure. // true - Success. //******************************************************************* boolean UpdateSubscriber(in CorbaDof::Tuple tSecurity, in TransactionManager::HCONNECTION hConnection, in CorbaDof::OID SubscriberOid, in CorbaDof::Tuple tSubscriber, out string sErrorMsg); //******************************************************************* // Function : UpdateSubscriberBackdated // // Description: // Update customer backdated details (same as the UpdateCustomer) with additional data. // // Parameters: // Input: // tSecurity - A security tuple that is used to identify // the user of this function. // hConnection - Database connection. Pass -1 if no connection // in use. // SubscriberOid - The identifier of Subscriber. // tSubscriber - The subscriber's details to update in the // database. The status field can not be // updated by this function. // tOperationData - Operation Data like UserId and Reason of change anf effective date // range of the operation // Output: // sErrorMsg - Error message where applicable. // // // Returns: // false - Failure. // true - Success. //******************************************************************* boolean UpdateSubscriberBackdated(in CorbaDof::Tuple tSecurity, in TransactionManager::HCONNECTION hConnection, in CorbaDof::OID SubscriberOid, in CorbaDof::Tuple tSubscriber, in CorbaDof::Tuple tOperationData, out string sErrorMsg); //******************************************************************* // Function : DeleteSubscriber // // Description: // Deletes subscriber and it's services if in prospective // state and have no transactions or charges. // // Parameters: // Input: // tSecurity - A security tuple that is used to identify // the user of this function. // hConnection - Database connection. Pass -1 if no connection // in use. // SubscriberOid - The identifier of Subscriber. // Output: // sErrorMsg - Error message where applicable. // // // Returns: // false - Failure. // true - Success. //******************************************************************* boolean DeleteSubscriber(in CorbaDof::Tuple tSecurity, in TransactionManager::HCONNECTION hConnection, in CorbaDof::OID SubscriberOid, out string sErrorMsg); //******************************************************************* // Function : TerminateSubscriber // // Description: // Terminate a subscriber. // // Parameters: // Input: // tSecurity - A security tuple that is used to identify // the user of this function. // hConnection - Database connection. Pass -1 if no connection // in use. // SubscriberOid - The identifier of Subscriber. // dExpDateTime - Effective date of the termination. // Output: // sErrorMsg - Error message where applicable. // // // Returns: // false - Failure. // true - Success. //******************************************************************* boolean TerminateSubscriber(in CorbaDof::Tuple tSecurity, in TransactionManager::HCONNECTION hConnection, in CorbaDof::OID SubscriberOid, in CorbaDof::Date dExpDateTime, in string sReason, out string sErrorMsg); //******************************************************************* // Function : SuspendSubscriber // // Description: // Suspends subscriber and it's customer products. // // Parameters: // Input: // tSecurity - A security tuple that is used to identify // the user of this function. // hConnection - Database connection. Pass -1 if no connection // in use. // SubscriberOid - The identifier of Subscriber. // sReason - Reason for customer suspension. // Output: // sErrorMsg - Error message where applicable. // // // Returns: // false - Failure. // true - Success. //******************************************************************* boolean SuspendSubscriber(in CorbaDof::Tuple tSecurity, in TransactionManager::HCONNECTION hConnection, in CorbaDof::OID SubscriberOid, in string sReason, out string sErrorMsg); //******************************************************************* // Function : UnSuspendSubscriber // // Description: // Unsuspends subscriber and it's customer products. // // Parameters: // Input: // tSecurity - A security tuple that is used to identify // the user of this function. // hConnection - Database connection. Pass -1 if no connection // in use. // SubscriberOid - The identifier of Subscriber. // sReason - Reason for customer unsuspension. // Output: // sErrorMsg - Error message where applicable. // // // Returns: // false - Failure. // true - Success. //******************************************************************* boolean UnSuspendSubscriber(in CorbaDof::Tuple tSecurity, in TransactionManager::HCONNECTION hConnection, in CorbaDof::OID SubscriberOid, in string sReason, out string sErrorMsg); //******************************************************************* // Function : GetAvailableProducts // // Description: // Get the available products that the Subscriber can purchase // but has not purchased yet. // // Parameters: // Input: // hConnection - Database connection. Pass -1 if no connection // in use. // SubscriberOid - The identifier of Customer. // Output: // tlProduct - List of products. // tlProductRelations // - The Product Relations list. // sErrorMsg - Error message where applicable. // // // Returns: // false - Failure. // true - Success. //******************************************************************* boolean GetAvailableProducts(in TransactionManager::HCONNECTION hConnection, in CorbaDof::OID SubscriberOid, out CorbaDof::TupleList tlProduct, out CorbaDof::TupleList tlProductRelations, out string sErrorMsg); //******************************************************************* // Function : GetSubscriberProducts // // Description: // Get subscriber products. All products subscriber owns are retrived. // All entries in cust_product table the subscriber_obj_num equals // the subscriber OID.m_object_number // // Parameters: // Input: // hConnection - Database connection. Pass -1 if no connection // in use. // SubscriberOid - The identifier of Subscriber. // Output: // tlProducts - List of the customer products. // sErrorMsg - Error message where applicable. // // Returns: // false - Failure. // true - Success. //******************************************************************* boolean GetSubscriberProducts(in TransactionManager::HCONNECTION hConnection, in CorbaDof::OID SubscriberOid, out CorbaDof::TupleList tlProducts, out string sErrorMsg); //******************************************************************* // Function : GetSubProductsServices // // Description: // Get tree of customer products and services. Containing the // following fields:cust_product_oid, product_oid, product_name, // product_status, cust_product_name, service_oid, service_name, // cust_service_oid, cust_service_name, cust_service_status // // Parameters: // Input: // hConnection - Database connection. Pass -1 if no connection // in use. // SubscriberOid - The identifier of Subscriber. // Output: // tlResults - List of the customer products, products, services // and customer services. // sErrorMsg - Error message where applicable. // // Returns: // false - Failure. // true - Success. //******************************************************************* boolean GetSubProductsServices(in TransactionManager::HCONNECTION hConnection, in CorbaDof::OID SubscriberOid, out CorbaDof::TupleList tlResults, out string sErrorMsg); //******************************************************************* // Function : PurchaseProductServices // // Description: // The function can be used to purchase product and a number of // it's services for a subscriber by suppling all the nessasery // data. // // Parameters: // Input: // tSecurity - Contining user id used to log the // action. // hConnection - Database connection. Pass -1 if no connection // in use. // ProductOid - The object identifier of the product. // SubscriberOid - The object identifier of the subscriber. // CustomerOid - The object identifier of the customer. // tProduct - A value-pair list containing the // following data regarding the customer // product: // Customer object number. // Subscriber object number. // Product object number. // Purchase date. // Activation date. // Expiration date. // Status. // tlServices - A value-pair list containing the the // following customer service data: // Customer object number. // Service object number. // Customer service name (optional). // Activation date. // Expiration date. // Status. // All service parameters and their // values should be also added to the // value-pair list. For example User // name or type of service. // Output: // sErrorMsg - Error message where applicable. // // // Returns: // false - Failure. // true - Success. //******************************************************************* boolean PurchaseProductServices(in CorbaDof::Tuple tSecurity, in TransactionManager::HCONNECTION hConnection, in CorbaDof::OID ProductOid, in CorbaDof::OID SubscriberOid, in CorbaDof::OID CustomerOid, in CorbaDof::Tuple tProduct, in CorbaDof::TupleList tlServices, out string sErrorMsg); //******************************************************************* // Function : CreateMarketLevelBanks // // Description: // Creates customer banks from the market level general product // for subscriber. // // Parameters: // Input: // tSecurity - Contining user id used to log the // action. // hConnection - Database connection. Pass -1 if no connection // in use. // SubscriberOid - The identifier of Subscriber. // Output: // sErrorMsg - Error message where applicable. // // Returns: // false - Failure. // true - Success. //******************************************************************* boolean CreateMarketLevelBanks(in CorbaDof::Tuple tSecurity, in TransactionManager::HCONNECTION hConnection, in CorbaDof::OID SubscriberOid, out string sErrorMsg); //******************************************************************* // Function :ReActivateSubscriber // Description: // Reactivate subscriber. (more like undo terminate) // Parameters: // input: // tSecurity - Containing user id used to log the action // hConnection - Connection to DB. // SubscriberOID - Subscriber OID. // tResourceChange - Containing the information if there is a resource change. // sErrorMsg - Error message // // Returns: // true - SUCCESS. // false - FAILURE. //******************************************************************* boolean ReActivateSubscriber(in CorbaDof::Tuple tSecurity, in TransactionManager::HCONNECTION hConnection, in CorbaDof::OID SubscriberOid, in CorbaDof::Tuple tResourceChange, out string sErrorMsg); //******************************************************************* // Function : ChangeIdentifier // // Description: // Change value of old identifier to a new value. // When bSpecificServiceType = 1: Change only identifiers of the // given Service Type. // // Parameters: // tSecurity - A security tuple that is used to identify the user of this function. // hConnection - DB connection. Pass -1 if no connection // SubscriberOid - The object identifier of the subscriber. // sOldIdentifier - The current value of the Identifier. // sNewIdentifier - The new value to change the Identifier to. // sServiceTypeExternalId- The service type to use // bSpecificServiceType - 0 = Identifiers of all Service Types // 1 = Only Identifiers of specific Service Type // lChangeDate - The date of change. // sErrorMsg - Error message where applicable. //******************************************************************* boolean ChangeIdentifier(in CorbaDof::Tuple tSecurity, in TransactionManager::HCONNECTION hConnection, in CorbaDof::OID SubscriberOid, in string sOldIdentifier, in string sNewIdentifier, in string sServiceTypeExternalId, in boolean bSpecificServiceType, in long lEffChangeDate, out string sErrorMsg); //******************************************************************* // Function :ActivateProspectiveSubscriber // Description: // This function support activation of prospective subscriber // with all its prospective products and services // Parameters: // input: // tSecurity - Containing user id used to log the action // hConnection - Connection to DB. // SubscriberOID - Subscriber OID. // tActivationDateTime - Containing the information if there is a resource change. // sErrorMsg - Error message // // Returns: // true - SUCCESS. // false - FAILURE. //******************************************************************* boolean ActivateProspectiveSubscriber(in CorbaDof::Tuple tSecurity, in TransactionManager::HCONNECTION hConnection, in CorbaDof::OID SubscriberOid, in CorbaDof::Date tActivationDateTime, out string sErrorMsg); //******************************************************************* // Function : ActivateProspectiveSubscriberList // // Description: // This function support activation of a list of prospective // subscribers with all its prospective products and services. // // Parameters: // tSecurity - A security tuple that is used to identify the // user of this function. Must contain 'UserId' // element containing a valid CSR user name. // hConnection - Database connection.Pass -1 if no connection // in use. // CustomerOid - The identifier of the Customer. // CustomerExtId - The external identifier of the Customer. // tlSubscriberID - List of customer subscriber IDs // tActivationDateTime - Activation Time for all the subscribers. // sErrorMsg - Error message where applicable. // // Returns: // false - Failure. // true - Success. //******************************************************************* boolean ActivateProspectiveSubscriberList(in CorbaDof::Tuple tSecurity, in TransactionManager::HCONNECTION hConnection, in CorbaDof::OID CustomerOid, in string CustomerExtId, in CorbaDof::TupleList tlSubscriberID, in CorbaDof::Date tActivationDateTime, out string sErrorMsg); //******************************************************************* // Function :CancelProspectiveSubscriber // Description: // This function support cancellation of prospective subscriber // with all its prospective products and services // Parameters: // input: // tSecurity - Containing user id used to log the action // hConnection - Connection to DB. // SubscriberOID - Subscriber OID. // tCancelDateTime - Effective date of the cancellation. // sReason - Reason description of customer status change. // Output: // bChargeIndication - Indicate pending to pay charges for this product. // sErrorMsg - Error message where applicable. // // Returns: // true - SUCCESS. // false - FAILURE. //******************************************************************* boolean CancelProspectiveSubscriber(in CorbaDof::Tuple tSecurity, in TransactionManager::HCONNECTION hConnection, in CorbaDof::OID SubscriberOid, in CorbaDof::Date tCancelDateTime, in string sReason, out boolean bChargeIndication, out string sErrorMsg); //******************************************************************* // Function : CancelProspectiveSubscriberList // // Description: // This function support cancellation of prospective a list of // subscribers with all its prospective products and services. // // Parameters: // tSecurity - A security tuple that is used to identify the // user of this function. Must contain 'UserId' // element containing a valid CSR user name. // hConnection - Database connection.Pass -1 if no connection // in use. // CustomerOid - The identifier of the Customer. // CustomerExtId - The external identifier of the Customer. // tlSubscriberID - List of customer subscriber IDs to cancel. // tCancelDateTime - Effective date of the cancellation. // sReason - Reason description of customer status change. // bChargeIndication - Indicate pending to pay charges for one of the subscribers. // sErrorMsg - Error message where applicable. // // Returns: // false - Failure. // true - Success. //******************************************************************* boolean CancelProspectiveSubscriberList(in CorbaDof::Tuple tSecurity, in TransactionManager::HCONNECTION hConnection, in CorbaDof::OID CustomerOid, in string CustomerExtId, in CorbaDof::TupleList tlSubscriberID, in CorbaDof::Date tCancelDateTime, in string sReason, out boolean bChargeIndication, out string sErrorMsg); //******************************************************************* // Function :CancelProspectiveProduct // Description: // This function support cancellation of a prospective product // with all its prospective services. // Parameters: // Input: // tSecurity - Containing user id used to log the action // hConnection - Connection to DB. // CustProductOid - Subscriber OID. // tCancelDateTime - Effective date of the cancellation. // sReason - Reason description of customer status change. // Output: // bChargeIndication - Indicate pending to pay charges for this product. // sErrorMsg - Error message where applicable. // // Returns: // true - SUCCESS. // false - FAILURE. //******************************************************************* boolean CancelProspectiveProduct(in CorbaDof::Tuple tSecurity, in TransactionManager::HCONNECTION hConnection, in CorbaDof::OID CustProductOid, in CorbaDof::Date tCancelDateTime, in string sReason, out boolean bChargeIndication, out string sErrorMsg); //******************************************************************* // Function :CancelProspectiveService // Description: // This function support cancellation of a prospective service. // Parameters: // Input: // tSecurity - Containing user id used to log the action // hConnection - Connection to DB. // CustProductOid - Subscriber OID. // tCancelDateTime - Effective date of the cancellation. // sReason - Reason description of customer status change. // Output: // bChargeIndication - Indicate pending to pay charges for this product. // sErrorMsg - Error message where applicable. // // Returns: // true - SUCCESS. // false - FAILURE. //******************************************************************* boolean CancelProspectiveService(in CorbaDof::Tuple tSecurity, in TransactionManager::HCONNECTION hConnection, in CorbaDof::OID CustServiceOid, in CorbaDof::Date tCancelDateTime, in string sReason, out boolean bChargeIndication, out string sErrorMsg); //******************************************************************* // Function : ChangeSubscriberOwnership // // Description: // This function moves a subscriber and its products to another customer // Parameters: // tSecurity - A security tuple that is used to identify the // user of this function. Must contain 'UserId' // element containing a valid CSR user name. // hConnection - Database connection.Pass -1 if no connection // in use. // SubscriberOid - The old subscriber OID // NewCustomerOid - The new Customer OID. // bCopyProdServInd - Indicator to copy products and services // bCopyBanksCreditLimit - Indicator to copy Credit limit // bCopyBanksThreshold - Indicator to copy cust banks thresholds // bSetBanksBeforeTermination - Indicator to set banks value before original subscriber termination // sErrorMsg - Error message where applicable. // // Returns: // false - Failure. // true - Success. //******************************************************************* boolean ChangeSubscriberOwnership(in CorbaDof::Tuple tSecurity, in TransactionManager::HCONNECTION hConnection, in CorbaDof::OID SubscriberOid, in CorbaDof::OID NewCustomerOid, in boolean bCopyProdServInd, in boolean bCopyBanksCreditLimit, in boolean bCopyBanksThreshold, in boolean bSetBanksBeforeTermination, out string sErrorMsg); //******************************************************************* // Function : ChangeSubscriberOwnershipValidation // // Description: // Perform validation for allowing the Change subscriber ownership // Parameters: // tSecurity - A security tuple that is used to identify the // user of this function. Must contain 'UserId' // element containing a valid CSR user name. // hConnection - Database connection.Pass -1 if no connection // in use. // SubscriberOid - The old subscriber OID // NewCustomerOid - The new Customer OID. // bCopyProdServInd - Indicator to copy products and services // oMoveIndication - Output indicator to allow change subscriber ownership // sErrorMsg - Error message where applicable. // // Returns: // false - Failure. // true - Success. //******************************************************************* boolean ChangeSubscriberOwnershipValidation(in CorbaDof::Tuple tSecurity, in TransactionManager::HCONNECTION hConnection, in CorbaDof::OID SubscriberOid, in CorbaDof::OID NewCustomerOid, in boolean bCopyProdServInd, in long lRegistrationDateTime, out boolean oMoveIndication, out string sErrorMsg); //******************************************************************* //******************************************************************* // // C U S T O M E R P R O D U C T f u n c t i o n s // //******************************************************************* //******************************************************************* //******************************************************************* // Function : CreateCustProduct // // Description: // Create customer product. // // Parameters: // Input: // tSecurity - A security tuple that is used to identify // the user of this function. // hConnection - Database connection. Pass -1 if no connection // in use. // CustProductOid - The identifier of Customer product. The // object number passed as zero and returned // the new object number. // tCustProduct - The customer product details to create in // the database. The mandatory data fields: // Customer object number. // Subscriber object number. // Product object number. // Purchase date. // Activation date. // Expiration date. // Status: // valid values are: // Active (= 1). // Suspended (= 2)· // Terminated (= 3). // Output: // sErrorMsg - Error message where applicable. // // // Returns: // false - Failure. // true - Success. //******************************************************************* boolean CreateCustProduct(in CorbaDof::Tuple tSecurity, in TransactionManager::HCONNECTION hConnection, inout CorbaDof::OID CustProductOid, in CorbaDof::Tuple tCustProduct, out string sErrorMsg); //******************************************************************* // Function : GetCustProduct // // Description: // Get a customer product's details from the database. // // Parameters: // Input: // hConnection - Database connection. Pass -1 if no connection // in use. // CustProductOid - The identifier of Customer product. // Output: // tCustProduct - The customer product's details from the // database. // sErrorMsg - Error message where applicable. // // // Returns: // false - Failure. // true - Success. //******************************************************************* boolean GetCustProduct(in TransactionManager::HCONNECTION hConnection, in CorbaDof::OID CustProductOid, out CorbaDof::Tuple tCustProduct, out string sErrorMsg); //******************************************************************* // Function : GetCustProductList // // Description: // Search for customer products with parameters. // // Parameters: // Input: // hConnection - Database connection. Pass -1 if no connection // in use. // tSearchTuple - A tuple containing customer product searching // parameters. // Output: // tlCustProduct - List of customer products. // sErrorMsg - Error message where applicable. // // // Returns: // false - Failure. // true - Success. //******************************************************************* boolean GetCustProductList(in TransactionManager::HCONNECTION hConnection, in CorbaDof::Tuple tSearchTuple, out CorbaDof::TupleList tlCustProduct, out string sErrorMsg); //******************************************************************* // Function : UpdateCustProduct // // Description: // Update customer product details. // // Parameters: // Input: // tSecurity - A security tuple that is used to identify // the user of this function. // hConnection - Database connection. Pass -1 if no connection // in use. // CustProductOid - The identifier of Customer product. // tCustProduct - The cust product's details to update in the // database. The status field can not be // updated by this function. // Output: // sErrorMsg - Error message where applicable. // // // Returns: // false - Failure. // true - Success. //******************************************************************* boolean UpdateCustProduct(in CorbaDof::Tuple tSecurity, in TransactionManager::HCONNECTION hConnection, in CorbaDof::OID CustProductOid, in CorbaDof::Tuple tCustProduct, out string sErrorMsg); //******************************************************************* // Function : UpdateCustProductBackdated // // Description: // Update customer product details (same as the Update) with additional data.. // // Parameters: // Input: // tSecurity - A security tuple that is used to identify // the user of this function. // hConnection - Database connection. Pass -1 if no connection // in use. // CustProductOid - The identifier of Customer product. // tCustProduct - The cust product's details to update in the // database. The status field can not be // updated by this function. // tOperationData - Operation Data like UserId and Reason of change anf effective date // range of the operation // Output: // sErrorMsg - Error message where applicable. // // // Returns: // false - Failure. // true - Success. //******************************************************************* boolean UpdateCustProductBackdated(in CorbaDof::Tuple tSecurity, in TransactionManager::HCONNECTION hConnection, in CorbaDof::OID CustProductOid, in CorbaDof::Tuple tCustProduct, in CorbaDof::Tuple tOperationData, out string sErrorMsg); //******************************************************************* // Function : DeleteCustProduct // // Description: // Deletes customer product and it's services if in prespective // state and have no transactions or charges. // // Parameters: // Input: // tSecurity - A security tuple that is used to identify // the user of this function. // hConnection - Database connection. Pass -1 if no connection // in use. // CustProductOid - The identifier of Customer product. // tCustProduct - The cust product's details to update in the // database. The status field can not be // updated by this function. // Output: // sErrorMsg - Error message where applicable. // // // Returns: // false - Failure. // true - Success. //******************************************************************* boolean DeleteCustProduct(in CorbaDof::Tuple tSecurity, in TransactionManager::HCONNECTION hConnection, in CorbaDof::OID CustProductOid, out string sErrorMsg); //******************************************************************* // Function : TerminateCustProduct // // Description: // Terminate a customer product. // // Parameters: // Input: // tSecurity - A security tuple that is used to identify // the user of this function. // hConnection - Database connection. Pass -1 if no connection // in use. // CustProductOid - The identifier of Customer product. // sReason - Give the reason of termination // Output: // sErrorMsg - Error message where applicable. // // // Returns: // false - Failure. // true - Success. //******************************************************************* boolean TerminateCustProduct(in CorbaDof::Tuple tSecurity, in TransactionManager::HCONNECTION hConnection, in CorbaDof::OID CustProductOid, in string sReason, in CorbaDof::Date dExpirationDate, out string sErrorMsg); //******************************************************************* // Function : TerminateCustProductDated // // Description: // Terminate a customer product with a date of expiry. // // Parameters: // Input: // tSecurity - A security tuple that is used to identify // the user of this function. // hConnection - Database connection. Pass -1 if no connection // in use. // CustProductOid - The identifier of Customer product. // lExpDateTime - Effective date of the termination. // sReason - Give the reason of termination // Output: // sErrorMsg - Error message where applicable. // // // Returns: // false - Failure. // true - Success. //******************************************************************* boolean TerminateCustProductDated(in CorbaDof::Tuple tSecurity, in TransactionManager::HCONNECTION hConnection, in CorbaDof::OID CustProductOid, in long lExpDateTime, in string sReason, out string sErrorMsg); //******************************************************************* // Function : GetCustProductServices // // Description: // Get customer product services with quantity. // The function returns the list of services that may be // activated by the customer for the given customer product and // the related quantity for each service. // // Parameters: // Input: // hConnection - Database connection. Pass -1 if no connection // in use. // CustProductOid - The identifier of Customer product. // Output: // tlServices - List of services and their available quantity. // sErrorMsg - Error message where applicable. // // // Returns: // false - Failure. // true - Success. //******************************************************************* boolean GetCustProductServices(in TransactionManager::HCONNECTION hConnection, in CorbaDof::OID CustProductOid, out CorbaDof::TupleList tlServices, out string sErrorMsg); //******************************************************************* // Function : SuspendCustProduct // // Description: // Suspends customer product and it's services. // // Parameters: // Input: // tSecurity - A security tuple that is used to identify // the user of this function. // hConnection - Database connection. Pass -1 if no connection // in use. // CustProductOid - The identifier of Customer product. // sReason - Reason for customer product suspension. // Output: // sErrorMsg - Error message where applicable. // // // Returns: // false - Failure. // true - Success. //******************************************************************* boolean SuspendCustProduct(in CorbaDof::Tuple tSecurity, in TransactionManager::HCONNECTION hConnection, in CorbaDof::OID CustProductOid, in string sReason, out string sErrorMsg); //******************************************************************* // Function : UnSuspendCustProduct // // Description: // Unsuspends customer product and it's services. // // Parameters: // Input: // tSecurity - A security tuple that is used to identify // the user of this function. // hConnection - Database connection. Pass -1 if no connection // in use. // CustProductOid - The identifier of Customer product. // sReason - Reason for customer product unsuspension. // Output: // sErrorMsg - Error message where applicable. // // // Returns: // false - Failure. // true - Success. //******************************************************************* boolean UnSuspendCustProduct(in CorbaDof::Tuple tSecurity, in TransactionManager::HCONNECTION hConnection, in CorbaDof::OID CustProductOid, in string sReason, out string sErrorMsg); //******************************************************************* // Function : ExtendProductExp // // Description: // Extend customer product expiration date. // // Parameters: // Input: // tSecurity - A security tuple that is used to identify // the user of this function. // hConnection - Database connection. Pass -1 if no connection // in use. // CustProductOid - The identifier of Customer product. // lDays - The number of days to extend the expiration // date by. // Output: // sErrorMsg - Error message where applicable. // // // Returns: // false - Failure. // true - Success. //******************************************************************* boolean ExtendProductExp(in CorbaDof::Tuple tSecurity, in TransactionManager::HCONNECTION hConnection, in CorbaDof::OID CustProductOid, in long lDays, out string sErrorMsg); //******************************************************************* // Function : ActivateCustProduct // // Description: // Activate customer product and it's services. // // Parameters: // Input: // tSecurity - A security tuple that is used to identify // the user of this function. // hConnection - Database connection. Pass -1 if no connection // in use. // CustProductOid - The identifier of Customer product. // dActivationDate- The date of activation. // Output: // sErrorMsg - Error message where applicable. // // Returns: // false - Failure. // true - Success. //******************************************************************* boolean ActivateCustProduct(in CorbaDof::Tuple tSecurity, in TransactionManager::HCONNECTION hConnection, in CorbaDof::OID CustProductOid, in CorbaDof::Date dActivationDate, out string sErrorMsg); //******************************************************************* // Function : GetContractProduct // // Description: // Get the reserved ContractProduct from configuration file. // // Parameters: // Output: // hConnection - Database connection. Pass -1 if no connection // in use. // ProductOid - The identifier of the contract product. // sErrorMsg - Error message where applicable. // // // Returns: // false - Failure. // true - Success. //******************************************************************* boolean GetContractProduct(in TransactionManager::HCONNECTION hConnection, out CorbaDof::OID ProductOid, out string sErrorMsg); //******************************************************************* // Function : ReplaceCustProduct // // Description: // Replaces the given customer product with the an instance of // the given product. // // Parameters: // Input: // hConnection - Database connection. Pass -1 if no connection // in use. // CustProductOid - The identifier of the replaced customer // product. // ProductOid - The identifier of the replacing product. // Output: // sErrorMsg - Error message where applicable. // // // Returns: // false - Failure. // true - Success. //******************************************************************* boolean ReplaceCustProduct(in TransactionManager::HCONNECTION hConnection, in CorbaDof::OID CustProductOid, in CorbaDof::OID ProductOid, out string sErrorMsg); //******************************************************************* // Function :ReActivateProduct // Description: // Reactivate Product. (more like undo terminate) // Parameters: // input: // tSecurity - Contining user id used to log the action // hConnection - Connection to DB. // SubscriberOID - Subscriber OID. // sErrorMsg - Error message // // Returns: // true - SUCCESS. // false - FAILURE. //******************************************************************* boolean ReActivateProduct(in CorbaDof::Tuple tSecurity, in TransactionManager::HCONNECTION hConnection, in CorbaDof::OID CustProductOid, out string sErrorMsg); //******************************************************************* //******************************************************************* // // C U S T O M E R S E R V I C E f u n c t i o n s // //******************************************************************* //******************************************************************* //******************************************************************* // Function : CreateCustService // // Description: // Create customer service. // // Parameters: // Input: // tSecurity - A security tuple that is used to identify // the user of this function. // hConnection - Database connection. Pass -1 if no connection // in use. // CustServiceOid - The identifier of Customer service. The // object number is passed zero and return the // new object number. // tCustService - The customer service details to create in // the database. The mandatory data fields are: // Customer object number. // Subscriber object number. // Customer product object number. // Service object number. // Activation date. // Expiration date. // Status: // valid values are: // Active (= 1). // Suspended (= 2)· // Terminated (= 3). // tServiceAvl - The attribute value list of the service // identifier and service parameters // bCheckAvl - Indication if to check the customer service avl // The check include find out if mandatory fields are exist // and valid . // Output: // sErrorMsg - Error message where applicable. // // // Returns: // false - Failure. // true - Success. //******************************************************************* boolean CreateCustService(in CorbaDof::Tuple tSecurity, in TransactionManager::HCONNECTION hConnection, inout CorbaDof::OID CustServiceOid, in CorbaDof::Tuple tCustService, in CorbaDof::Tuple tServiceAvl, out string sErrorMsg, in boolean bCheckAvl); //******************************************************************* // Function : GetCustService // // Description: // Get a customer service's details from the database. // // Parameters: // Input: // hConnection - Database connection. Pass -1 if no connection // in use. // CustServiceOid - The identifier of Customer service. // Output: // tCustService - The customer service's details from the // database. // tServiceAvl - The attribute-value list, containing the // customer service parameters. // sErrorMsg - Error message where applicable. // // // Returns: // false - Failure. // true - Success. //******************************************************************* boolean GetCustService(in TransactionManager::HCONNECTION hConnection, in CorbaDof::OID CustServiceOid, out CorbaDof::Tuple tCustService, out CorbaDof::Tuple tServiceAvl, out string sErrorMsg); //******************************************************************* // Function : GetCustServiceList // // Description: // Search for customer service with parameters. The list of the // parameters corresponding to the list of services. // // Parameters: // Input: // hConnection - Database connection. Pass -1 if no connection // in use. // tSearchTuple - A tuple containing customer product searching // parameters. // Output: // tlCustService - List of customer services. // tlServiceAvl - List of service parameters attribute-value // list. // sErrorMsg - Error message where applicable. // // // Returns: // false - Failure. // true - Success. //******************************************************************* boolean GetCustServiceList(in TransactionManager::HCONNECTION hConnection, in CorbaDof::Tuple tSearchTuple, out CorbaDof::TupleList tlCustService, out CorbaDof::TupleList tlServiceAvl, out string sErrorMsg); //******************************************************************* // Function : GetAllCustServiceList // // Description: // Search for customer service with parameters. The list of the // parameters corresponding to the list of services. // The list contain all the cust service status. // // Parameters: // Input: // hConnection - Database connection. Pass -1 if no connection // in use. // tSearchTuple - A tuple containing customer product searching // parameters. (not include status) // Output: // tlCustService - List of customer services. // tlServiceAvl - List of service parameters attribute-value // list. // sErrorMsg - Error message where applicable. // // // Returns: // false - Failure. // true - Success. //******************************************************************* boolean GetAllCustServiceList(in TransactionManager::HCONNECTION hConnection, in CorbaDof::Tuple tSearchTuple, out CorbaDof::TupleList tlCustService, out CorbaDof::TupleList tlServiceAvl, out string sErrorMsg); //******************************************************************* // Function : UpdateCustService // // Description: // Update customer service details and their service parameters. // The list of the AVL should be corresponding to the list of // services. // // Parameters: // Input: // tSecurity - A security tuple that is used to identify // the user of this function. // hConnection - Database connection. Pass -1 if no connection // in use. // CustServiceOid - The identifier of Customer service. // tCustService - The cust service's details to update in the // database. The Customer Service status cannot // be updated using this function. // tServiceAvl - The attribute-value list, containing the // updated customer service parameters. // Output: // sErrorMsg - Error message where applicable. // // // Returns: // false - Failure. // true - Success. //******************************************************************* boolean UpdateCustService(in CorbaDof::Tuple tSecurity, in TransactionManager::HCONNECTION hConnection, in CorbaDof::OID CustServiceOid, in CorbaDof::Tuple tCustService, in CorbaDof::Tuple tServiceAvl, out string sErrorMsg); //******************************************************************* // Function : UpdateCustServiceBackdated // // Description: // Backdated Update customer service operation and their service parameters. // The list of the AVL should be corresponding to the list of // services. // // Parameters: // Input: // tSecurity - A security tuple that is used to identify // the user of this function. // hConnection - Database connection. Pass -1 if no connection // in use. // CustServiceOid - The identifier of Customer service. // tCustService - The cust service's details to update in the // database. The Customer Service status cannot // be updated using this function. // tServiceAvl - The attribute-value list, containing the // updated customer service parameters. // tOperationData - Operation Data like UserId and Reason of change anf effective date // range of the operation // Output: // sErrorMsg - Error message where applicable. // // // Returns: // false - Failure. // true - Success. //******************************************************************* boolean UpdateCustServiceBackdated(in CorbaDof::Tuple tSecurity, in TransactionManager::HCONNECTION hConnection, in CorbaDof::OID CustServiceOid, in CorbaDof::Tuple tCustService, in CorbaDof::Tuple tServiceAvl, in CorbaDof::Tuple tOperationData, out string sErrorMsg); // Delete CustService. boolean DeleteCustService(in CorbaDof::Tuple tSecurity, in TransactionManager::HCONNECTION hConnection, in CorbaDof::OID CustServiceOid, out string sErrorMsg); //******************************************************************* // Function :ServiceCancellation // // Description: // Cancel customer service and credit back the usage charging // of the given cust service. // // Parameters: // Input: // tSecurity - A security tuple that is used to identify // the user of this function. // hConnection - Database connection. Pass -1 if no connection // in use. // CustServiceOid - The identifier of Customer service. // dEffDate - Cancellation Date // Date foramt must be: "YYYYMMDD" // bReverseUsage - Whether or not to credit back usage // sErrorMsg - Error message where applicable. // // // Returns: // false - Failure. // true - Success. boolean ServiceCancellation(in CorbaDof::Tuple tSecurity, in TransactionManager::HCONNECTION hConnection, in CorbaDof::OID CustServiceOid, in CorbaDof::Date dEffDate, in boolean bReverseUsage, out string sErrorMsg); //******************************************************************* // Function : TerminateCustService // // Description: // Terminate a customer service. // // Parameters: // Input: // tSecurity - A security tuple that is used to identify // the user of this function. // hConnection - Database connection. Pass -1 if no connection // in use. // CustServiceOid - The identifier of Customer service. // lExpDateTime - Effective date of the termination. // Output: // sErrorMsg - Error message where applicable. // // // Returns: // false - Failure. // true - Success. //******************************************************************* boolean TerminateCustService(in CorbaDof::Tuple tSecurity, in TransactionManager::HCONNECTION hConnection, in CorbaDof::OID CustServiceOid, in long lExpDateTime, in string sReason, out string sErrorMsg); //******************************************************************* // Function : GetIdentifierParamOid // // Description: // Get the identifier service parameter oid. // // Parameters: // Input: // hConnection - Database connection. Pass -1 if no connection // in use. // ServiceOid - The identifier of the service. // Output: // ServiceParamOid - The identifier of service parameter used // as a service type identifier. // sErrorMsg - Error message where applicable. // // // Returns: // false - Failure. // true - Success. //******************************************************************* boolean GetIdentifierParamOid(in TransactionManager::HCONNECTION hConnection, in CorbaDof::OID ServiceOid, out CorbaDof::OID ServiceParamOid, out string sErrorMsg); //******************************************************************* // Function : CheckServiceIdent // // Description: // Check if a service type identifier exists for a service type // used by the specified service. // // Parameters: // Input: // hConnection - Database connection. Pass -1 if no connection // in use. // ServiceOid - The identifier of the service. // sIdentName - The service type identifier name. // Output: // bFound - The service type identifier exists or not. // sErrorMsg - Error message where applicable. // // // Returns: // false - Failure. // true - Success. //******************************************************************* boolean CheckServiceIdent(in TransactionManager::HCONNECTION hConnection, in CorbaDof::OID ServiceOid, in string sIdentName, out boolean Found, out string sErrorMsg); //******************************************************************* // Function : SuspendCustService // // Description: // Suspend a customer service. // // Parameters: // Input: // tSecurity - A security tuple that is used to identify // the user of this function. // hConnection - Database connection. Pass -1 if no connection // in use. // CustServiceOid - The identifier of Customer service. // sReason - The reason description of the CustService suspension // Output: // sErrorMsg - Error message where applicable. // // // Returns: // false - Failure. // true - Success. //******************************************************************* boolean SuspendCustService(in CorbaDof::Tuple tSecurity, in TransactionManager::HCONNECTION hConnection, in CorbaDof::OID CustServiceOid, in string sReason, out string sErrorMsg); //******************************************************************* // Function : UnSuspendCustService // // Description: // Unsuspend a customer service. // // Parameters: // Input: // tSecurity - A security tuple that is used to identify // the user of this function. // hConnection - Database connection. Pass -1 if no connection // in use. // CustServiceOid - The identifier of Customer service. // sReason - The reason description of the CustService unsuspension // Output: // sErrorMsg - Error message where applicable. // // // Returns: // false - Failure. // true - Success. //******************************************************************* boolean UnSuspendCustService(in CorbaDof::Tuple tSecurity, in TransactionManager::HCONNECTION hConnection, in CorbaDof::OID CustServiceOid, in string sReason, out string sErrorMsg); //******************************************************************* // Function : ExtendServiceExp // // Description: // Extend customer service expiration date. // // Parameters: // Input: // tSecurity - A security tuple that is used to identify // the user of this function. // hConnection - Database connection. Pass -1 if no connection // in use. // CustServiceOid - The identifier of Customer service. // lDays - The number of days to extend the expiration // date. // Output: // sErrorMsg - Error message where applicable. // // // Returns: // false - Failure. // true - Success. //******************************************************************* boolean ExtendServiceExp(in CorbaDof::Tuple tSecurity, in TransactionManager::HCONNECTION hConnection, in CorbaDof::OID CustServiceOid, in long lDays, out string sErrorMsg); // Get list of service parameters. boolean GetServiceParams(in TransactionManager::HCONNECTION hConnection, in CorbaDof::OID CustServiceOid, out CorbaDof::TupleList tlServiceParams, out string sErrorMsg); //******************************************************************* // Function : ActivateCustService // // Description: // Activate customer service. // // Parameters: // Input: // tSecurity - A security tuple that is used to identify // the user of this function. // hConnection - Database connection. Pass -1 if no connection // in use. // CustServiceOid - The identifier of Customer service. // Output: // sErrorMsg - Error message where applicable. // // Returns: // false - Failure. // true - Success. //******************************************************************* boolean ActivateCustService(in CorbaDof::Tuple tSecurity, in TransactionManager::HCONNECTION hConnection, in CorbaDof::OID CustServiceOid, in CorbaDof::Date dActivationDate, out string sErrorMsg); //******************************************************************* // Function : GetDefaultContract // // Description: // Get the reserved DefaultContract service from configuration // file. // // Parameters: // Output: // hConnection - Database connection. Pass -1 if no connection // in use. // ServiceOid - The identifier of the contract service. // sErrorMsg - Error message where applicable. // // // Returns: // false - Failure. // true - Success. //******************************************************************* boolean GetDefaultContract(in TransactionManager::HCONNECTION hConnection, out CorbaDof::OID ServiceOid, out string sErrorMsg); //******************************************************************* // Function : GetAvailableAddOnServices // // Description: // Get list of all available add ons for a given customer // service. // // Parameters: // Input: // hConnection - Database connection. Pass -1 if no // connection in use. // CustServiceOid - The identifier of the customer service. // Output: // tlProductServices - Add ons of the given product. // tlGeneralServices - Add ons of the general product. // sErrorMsg - Error message where applicable. // // // Returns: // false - Failure. // true - Success. //******************************************************************* boolean GetAvailableAddOnServices(in TransactionManager::HCONNECTION hConnection, in CorbaDof::OID CustServiceOid, out CorbaDof::TupleList tlProductServices, out CorbaDof::TupleList tlGeneralServices, out string sErrorMsg); //******************************************************************* // Function : GetCustServiceParams // // Description: // Returnes list of customer service parameters combined of the // service parameters and their values from the avl. Also // returned the parameters of the base service with a base_ind. // // Parameters: // Input: // hConnection - Database connection. Pass -1 if no connection // in use. // CustServiceOid - The identifier of the customer service. // Output: // tlParams - Combined service parameters. // sErrorMsg - Error message where applicable. // // // Returns: // false - Failure. // true - Success. //******************************************************************* boolean GetCustServiceParams(in TransactionManager::HCONNECTION hConnection, in CorbaDof::OID CustServiceOid, out CorbaDof::TupleList tlParams, out string sErrorMsg); //******************************************************************* // Function : GetReplacementServices // // Description: // Returnes list of services within the product that can // replace the customer service presented. // // Parameters: // Input: // hConnection - Database connection. Pass -1 if no connection // in use. // CustServiceOid - The identifier of the replaced customer // service. // Output: // tlServices - Tuple list of the offered services. // sErrorMsg - Error message where applicable. // // // Returns: // false - Failure. // true - Success. //******************************************************************* boolean GetReplacementServices(in TransactionManager::HCONNECTION hConnection, in CorbaDof::OID CustServiceOid, out CorbaDof::TupleList tlServices, out string sErrorMsg); //******************************************************************* // Function : ReplaceCustService // // Description: // Replaces th given customer service with the an instance of // the given service. // // Parameters: // Input: // tSecurity - A security tuple that is used to identify // the user of this function. // hConnection - Database connection. Pass -1 if no connection // in use. // CustServiceOid - The identifier of the replaced customer // service. // ServiceOid - The identifier of the replacing service. // dReplaceEffDate - Replacement date must be between the activation date // and the effective day (CurrentTime ). // Date foramt must be: "YYYYMMDD" // Output: // sErrorMsg - Error message where applicable. // // // Returns: // false - Failure. // true - Success. //******************************************************************* boolean ReplaceCustService(in CorbaDof::Tuple tSecurity, in TransactionManager::HCONNECTION hConnection, inout CorbaDof::OID CustServiceOid, in CorbaDof::OID ServiceOid, in boolean bProrating, in CorbaDof::Date dReplaceEffDate, in CorbaDof::Tuple tOverrideAvl, out string sErrorMsg); //******************************************************************* // Function :ReActivateService // Description: // Reactivate Service. (more like undo terminate) // Parameters: // input: // tSecurity - Contining user id used to log the action // hConnection - Connection to DB. // CustServiceOID - Subscriber OID. // sErrorMsg - Error message // // Returns: // true - SUCCESS. // false - FAILURE. //******************************************************************* boolean ReActivateService(in CorbaDof::Tuple tSecurity, in TransactionManager::HCONNECTION hConnection, in CorbaDof::OID CustServiceOid, out string sErrorMsg); //******************************************************************* //******************************************************************* // // C U S T O M E R B A N K f u n c t i o n s // //******************************************************************* //******************************************************************* //******************************************************************* // Function : CreateCustBank // // Description: // Create a customer bank. // // Parameters: // Input: // tSecurity - A security tuple that is used to identify // the user of this function. // hConnection - Database connection. Pass -1 if no connection // in use. // CustBankOid - The identifier of Customer bank when the // object number received is 0 and the new // customer bank object number returned. // tCustBank - The customer bank details to create in the // database. The mandatory data fields are: // Customer object number. // Bank object number. // Bank Type // 1 - Customer Accumulated Cyclic Bank. // 2 - Customer Tx Bank· // 3 - Service Accumulated Cyclic Bank. // Output: // sErrorMsg - Error message where applicable. // // // Returns: // false - Failure. // true - Success. //******************************************************************* boolean CreateCustBank(in CorbaDof::Tuple tSecurity, in TransactionManager::HCONNECTION hConnection, inout CorbaDof::OID CustBankOid, in CorbaDof::Tuple tCustBank, out string sErrorMsg); //******************************************************************* // Function : GetCustBank // // Description: // Get a customer bank's details from the database. // Fetching the following additional information: // bank_name, // precision, // attribute_obj_num, // attribute_name, // source_type of the related attribute, // unit_sign, // currency_ind. // Add for Cyclic Bank also: // next_balance_date. // Add for Service Accumulated Bank also: // cust_service_name. // // Parameters: // Input: // hConnection - Database connection. Pass -1 if no connection // in use. // CustBankOid - The identifier of Customer bank. // Output: // tCustBank - The customer bank's details from the // database. // sErrorMsg - Error message where applicable. // // // Returns: // false - Failure. // true - Success. //******************************************************************* boolean GetCustBank(in TransactionManager::HCONNECTION hConnection, in CorbaDof::OID CustBankOid, out CorbaDof::Tuple tCustBank, out string sErrorMsg); //******************************************************************* // Function : UpdateCustBank // // Description: // Update customer bank details. Currently can be used for // updating credit limit only. // // Parameters: // Input: // tSecurity - A security tuple that is used to identify // the user of this function. // hConnection - Database connection. Pass -1 if no connection // in use. // CustBankOid - The identifier of Customer bank. // tCustBank - The cust bank's details to update in the // database. // Output: // sErrorMsg - Error message where applicable. // // // Returns: // false - Failure. // true - Success. //******************************************************************* boolean UpdateCustBank(in CorbaDof::Tuple tSecurity, in TransactionManager::HCONNECTION hConnection, in CorbaDof::OID CustBankOid, in CorbaDof::Tuple tCustBank, out string sErrorMsg); //******************************************************************* // Function : GetCustBankList // // Description: // Search for customer banks with parameters. // // Parameters: // Input: // hConnection - Database connection. Pass -1 if no connection // in use. // tSearchTuple - A tuple containing customer bank searching // parameters. // Output: // tlCustProduct - List of customer banks. // sErrorMsg - Error message where applicable. // // // Returns: // false - Failure. // true - Success. //******************************************************************* boolean GetCustBankList(in TransactionManager::HCONNECTION hConnection, in CorbaDof::Tuple tSearchTuple, out CorbaDof::TupleList tlCustBank, out string sErrorMsg); //******************************************************************* // Function : GetBankDisplayList // // Description: // Get customer banks objects list for display purposes. // Ordering transaction banks first and cyclic banks afterwards. // Placing main currency bank first. // Display only banks that are allowed by their Visibility Type. // Fetching the following additional information: // bank_name, // precision, // attribute_obj_num, // attribute_name, // source_type of the related attribute, // unit_sign, // currency_ind. // Add for each Cyclic Bank also: // next_balance_date. // Add for each Service Accumulated Bank also: // cust_service_name. // // Parameters: // Input: // tSearch - A tuple containing customer bank searching // parameters. // bCsrRequest - Indicate whether the CSR request this list // or not. CSR request will include also the // banks that are presented only to CSR. // Output: // tlTxBanks - List of customer transaction banks. // tlCyclicBanks - List of customer cyclic banks. // sErrorMsg - Error message where applicable. // // // Returns: // false - Failure. // true - Success. //******************************************************************* boolean GetBankDisplayList(in CorbaDof::Tuple tSearch, out CorbaDof::TupleList tlTxBanks, out CorbaDof::TupleList tlCyclicBanks, out string sErrorMsg, in boolean bCsrRequest); //******************************************************************* // Function : GetSubBanksForVoucher // // Description: // Get a list of Customer Banks and Subscriber Banks, for given // customer and subscriber, that can be converted to a // certain attribute. The list will include only banks that // their attributes has unit conversion rate with the given // attribute. // The returned cust bank list inlude also the name of the static // bank as the value of the additional "name" tuple. // // Parameters: // Input: // CustomerOid - The customer Oid. // SubscriberOid - The subscriber Oid. // AttributeOid - The attribute Oid. // Output: // tlCustBank - The result list of customer banks. // sErrorMsg - Error message where applicable. // // // Returns: // false - Failure. // true - Success. //******************************************************************* boolean GetSubBanksForVoucher(in TransactionManager::HCONNECTION hConnection, in CorbaDof::OID CustomerOid, in CorbaDof::OID SubscriberOid, in CorbaDof::OID AttributeOid, out CorbaDof::TupleList tlCustBank, out string sErrorMsg); //******************************************************************* // Function : CustBankAdjustment // // Description: // Perform an adjustment on a cyclic bank. // // Parameters: // Input: // tSecurity - A security tuple that is used to identify // the user of this function. // hConnection - Database connection. Pass -1 if no connection // in use. // CustBankOID - The identifier of Customer bank. // InfoTuple - Holds the adjustment amount and reasonwith the name // "amount" ,"Reason". // Output: // sErrorMsg - Error message where applicable. // // // Returns: // false - Failure. // true - Success. //******************************************************************* boolean CustBankAdjustment(in CorbaDof::Tuple tSecurity, in TransactionManager::HCONNECTION hConnection, in CorbaDof::OID CustBankOID, in CorbaDof::Tuple InfoTuple, out string sErrorMsg); //******************************************************************* // Function : GetCustBankSign // // Description: // Returns the sign of the customer bunk measurement unit. // // Parameters: // Input: // hConnection - Database connection. Pass -1 if no connection // in use. // CustBankOID - The identifier of Customer bank. // Output: // sSign - Holds the bank sign. // bCurrencyInd - The currency indicator of the bank. // sErrorMsg - Error message where applicable. // // // Returns: // false - Failure. // true - Success. //******************************************************************* boolean GetCustBankSign(in TransactionManager::HCONNECTION hConnection, in CorbaDof::OID CustBankOID, out string sSign, out boolean bCurrencyInd, out string sErrorMsg); //******************************************************************* //******************************************************************* // // C U S T O M E R B A N K T X f u n c t i o n s // //******************************************************************* //******************************************************************* //******************************************************************* // Function : GetCustBankTx // // Description: // Get a customer bank transaction details from the database. // // Parameters: // Input: // hConnection - Database connection. Pass -1 if no connection // in use. // CustBankTxOid - The identifier of Customer bank transaction. // Output: // tCustBankTx - The customer bank transaction details from // the database. // sErrorMsg - Error message where applicable. // // // Returns: // false - Failure. // true - Success. //******************************************************************* boolean GetCustBankTx(in TransactionManager::HCONNECTION hConnection, in CorbaDof::OID CustBankTxOid, out CorbaDof::Tuple tCustBankTx, out string sErrorMsg); //******************************************************************* // Function : GetCustBankTxList // // Description: // Get a list of Customer Bank Transaction according to a range // search tuples. // // Parameters: // Input: // hConnection - Database connection. Pass -1 if no connection // in use. // tStartRangeTuple - The start range tuple. // tEndRangeTuple - The end range tuple. The tupls should // contain values existing in the Customer // bank transaction object. // lFromRow - The start number of row. // lNumOfRows - The number of rows to retrive. // Output: // tlCustBankTx - List of customer banks. // sErrorMsg - Error message where applicable. // // // Returns: // false - Failure. // true - Success. //******************************************************************* boolean GetCustBankTxList(in TransactionManager::HCONNECTION hConnection, in CorbaDof::Tuple tStartRangeTuple, in CorbaDof::Tuple tEndRangeTuple, in long lFromRow, in long lNumOfRows, out CorbaDof::TupleList tlCustBankTx, out string sErrorMsg); //******************************************************************* //******************************************************************* // // C U S T O M E R h i g h t l e v e l f u n c t i o n s // //******************************************************************* //******************************************************************* //******************************************************************* // Function : GetCustomerById // // Description: // Get a customer's details from the database by External Id. // // Parameters: // Input: // hConnection - Database connection. Pass -1 if no connection // in use. // sExternalId - The external identifier of Customer. // Output: // tData - The customer's details from the // database. // sErrorMsg - Error message where applicable. // // // Returns: // false - Failure. // true - Success. //******************************************************************* boolean GetCustomerById(in TransactionManager::HCONNECTION hConnection, in string sExternalId, out CorbaDof::Tuple tData, out string sErrorMsg); //******************************************************************* // Function : UpdateCustomerById // // Description: // Update customer's details in database by External Id. // // Parameters: // Input: // tSecurity - Contining user id used to log the // action. // hConnection - Database connection. Pass -1 if no connection // in use. // sExternalId - The external identifier of Customer. // Output: // tData - The customer's details from the // database. // sErrorMsg - Error message where applicable. // // // Returns: // false - Failure. // true - Success. //******************************************************************* boolean UpdateCustomerById(in CorbaDof::Tuple tSecurity, in TransactionManager::HCONNECTION hConnection, in string sExternalId, in CorbaDof::Tuple tData, out string sErrorMsg); //******************************************************************* // Function :SetBillableCustIndById // // Description: // Update Billable Cust Ind and Billable Cust Eff Date // in database by External Id. // The API will check the following : // 1.The effective date is not a retroactive date. // 2.The current customer billable_cust_ind is not equal to the // received value. // // // // Parameters: // Input // tSecurity -Contining user id used to log the // action. // hConnection - Database connection. Pass -1 if no connection // in use. // bBillableCustInd - Billable customer indication // lEffTime - Billibale customer indication effective date // (timestamp format) // sExternalId - The external identifier of Customer. // Output // sErrorMsg - Error message where applicable. // // Returns: // false - Failure. // true - Success. //******************************************************************* boolean SetBillableCustIndById(in CorbaDof::Tuple tSecurity, in TransactionManager::HCONNECTION hConnection, in string sExternalId, in boolean bBillableCustInd, in long lEffTime, out string sErrorMsg); //******************************************************************* // Function : SetBillableCustInd // // Description: // Update Billable Cust Ind and Billable Cust Eff Date // in database by Customer OID. // The API will check the following : // 1.The effective date is not a retroactive date. // 2.The current customer billable_cust_ind is not equal to the // received value. // // // Parameters: // Input // tSecurity -Contining user id used to log the // action. // hConnection - Database connection. Pass -1 if no connection // in use. // CustomerOid - Customer OID // // bBillableCustInd - Billable customer indication // // lEffTime - Billibale customer indication effective date // (timestamp format) // Output // sErrorMsg - Error message where applicable. // // Returns: // false - Failure. // true - Success. //******************************************************************* boolean SetBillableCustInd(in CorbaDof::Tuple tSecurity, in TransactionManager::HCONNECTION hConnection, in CorbaDof::OID CustomerOid, in boolean bBillableCustInd, in long lEffTime, out string sErrorMsg); //******************************************************************* // Function :SetInvoiceTypeById // // Description: // Update customer's Invoice type // in database by External Id. // The API will check the following : // 1. The current customer invoice type object number is not equal to the // received value. // 2.The customer invoice type object number is an existing in the DB. // Note: no checks are done if the invoice type is appopriate for this // customer // // // Parameters: // Input // tSecurity -Contining user id used to log the // action. // hConnection - Database connection. Pass -1 if no connection // in use. // sExternalId - The external identifier of Customer. // // InvoiceTypeOID - Invoice Type OID // Output // sErrorMsg - Error message where applicable. // // Returns: // false - Failure. // true - Success. //******************************************************************* boolean SetInvoiceTypeById(in CorbaDof::Tuple tSecurity, in TransactionManager::HCONNECTION hConnection, in string sExternalId, in CorbaDof::OID InvoiceTypeOID, out string sErrorMsg); //******************************************************************* // Function :SetInvoiceType // // Description: // Update customer's Invoice type // in database by Customer OID. // The API will check the following : // 1. The current customer invoice type object number is not equal to the // received value. // 2.The customer invoice type object number is an existing in the DB. // Note: no checks are done if the invoice type is appopriate for this // customer // // // Parameters: // Input // tSecurity -Contining user id used to log the // action. // hConnection - Database connection. Pass -1 if no connection // in use. // CustomerOID - Customer OID // InvoiceTypeOID - Invoice Type OID // // Output // sErrorMsg - Error message where applicable. // // Returns: // false - Failure. // true - Success. //******************************************************************* boolean SetInvoiceType(in CorbaDof::Tuple tSecurity, in TransactionManager::HCONNECTION hConnection, in CorbaDof::OID CustomerOid, in CorbaDof::OID InvoiceTypeOID, out string sErrorMsg); //******************************************************************* // Function : UpdateCustProfile // // Description: // Update customer profile used to access the system GUI and WSC. // The profile determines customer permissions for viewing and // updating data. // // Parameters: // Input: // tSecurity - Contining user id used to log the // action. // hConnection - Database connection. Pass -1 if no connection // in use. // sExternalId - The external identifier of customer. // sProfileName - The profile to be set for the // customer. // Output: // sErrorMsg - Error message where applicable. // // // Returns: // false - Failure. // true - Success. //******************************************************************* boolean UpdateCustProfile(in CorbaDof::Tuple tSecurity, in TransactionManager::HCONNECTION hConnection, in string sExternalId, in string sProfileName, out string sErrorMsg); //******************************************************************* // Function : UpdateCustIdentification // // Description: // Update customer user and password used to access the system // GUI and WSC. // // Parameters: // Input: // tSecurity - Contining user id used to log the // action. // hConnection - Database connection. Pass -1 if no connection // in use. // sExternalId - The external identifier of customer. // sUserName - The customer user name. // sPassword - The customer password. // Output: // sErrorMsg - Error message where applicable. // // // Returns: // false - Failure. // true - Success. //******************************************************************* boolean UpdateCustIdentification(in CorbaDof::Tuple tSecurity, in TransactionManager::HCONNECTION hConnection, in string sExternalId, in string sUserName, in string sPassword, out string sErrorMsg); //******************************************************************* // Function : UpdateResellerContract // // Description: // Change the reseller contract service. // The function terminates current reseller contract service // and purchases the new service according to the service name. // Both the old and the new services must belong to the same // product. // // Parameters: // Input: // tSecurity - Contining user id used to log the // action. // hConnection - Database connection. Pass -1 if no connection // in use. // sExternalId - The external identifier of the // reseller customer. // sServiceName - The new contract service name. // Output: // sErrorMsg - Error message where applicable. // // // Returns: // false - Failure. // true - Success. //******************************************************************* boolean UpdateResellerContract(in CorbaDof::Tuple tSecurity, in TransactionManager::HCONNECTION hConnection, in string sExternalId, in string sServiceName, out string sErrorMsg); //******************************************************************* // Function : RegisterRegularCust // // Description: // The function performs complete registration for regular // customer including the payment method and CSR service used // for the GUI access. // // Parameters: // Input: // tSecurity - Contining user id used to log the // action. // hConnection - Database connection. Pass -1 if no connection // in use. // tCustomer - A value-pair list containing all // customer data. // The following fields are mandatory: // Main user name. // Main password. // External customer id. // Market object number. // Event object number. // Invoice type object number. // Payment method object number. // Registration date. // tCSRService - The SCR service details used for GUI // access and permissions. // The following fields are mandatory: // User Id. // Main password. // Profile name. // tPayment - The payment method details that should // be filled according to the payment // method that was chosen for the // customer. // bValidatePay - Indicates whether the payment details // should be validated by the system. // Output: // CustomerOid - The created customer OID. // sErrorMsg - Error message where applicable. // // // Returns: // false - Failure. // true - Success. //******************************************************************* boolean RegisterRegularCust(in CorbaDof::Tuple tSecurity, in TransactionManager::HCONNECTION hConnection, in CorbaDof::Tuple tCustomer, in CorbaDof::Tuple tCSRService, in CorbaDof::Tuple tPayment, in boolean bValidatePay, out CorbaDof::OID CustomerOid, out string sErrorMsg); //******************************************************************* // Function : RegisterResellerCust // // Description: // The function performs complete registration for reseller // customer including the payment method and CSR service used // for the GUI access. It's also activates the customer and // creating market banks. // // Parameters: // Input: // tSecurity - Contining user id used to log the // action. // hConnection - Database connection. Pass -1 if no connection // in use. // tCustomer - A value-pair list containing all // customer data. // The following fields are mandatory: // Main user name. // Main password. // External customer id. // Market object number. // Event object number. // Invoice type object number. // Payment method object number. // Registration date. // tCSRService - The SCR service details used for GUI // access and permissions. // The following fields are mandatory: // User Id. // Main password. // Profile name. // tPayment - The payment method details that should // be filled according to the payment // method that was chosen for the // customer. // bValidatePay - Indicates whether the payment details // should be validated by the system. // sServiceName - The name of the contract service to // be purchased for the reseller. // Output: // CustomerOid - The created customer OID. // sErrorMsg - Error message where applicable. // // // Returns: // false - Failure. // true - Success. //******************************************************************* boolean RegisterResellerCust(in CorbaDof::Tuple tSecurity, in TransactionManager::HCONNECTION hConnection, in CorbaDof::Tuple tCustomer, in CorbaDof::Tuple tCSRService, in CorbaDof::Tuple tPayment, in boolean bValidatePay, in string sServiceName, out CorbaDof::OID CustomerOid, out string sErrorMsg); //******************************************************************* // Function : RegisterCorpCust // // Description: // The function performs complete registration for corporate // customer including the payment method and CSR service used // for the GUI access. It's also activates the customer and // creating market banks. // // Parameters: // Input: // tSecurity - Contining user id used to log the // action. // hConnection - Database connection. Pass -1 if no connection // in use. // tCustomer - A value-pair list containing all // customer data. // The following fields are mandatory: // Main user name. // Main password. // External customer id. // Market object number. // Event object number. // Invoice type object number. // Payment method object number. // Registration date. // Billable indicator. // tCSRService - The SCR service details used for GUI // access and permissions. // The following fields are mandatory: // User Id. // Main password. // Profile name. // tPayment - The payment method details that should // be filled according to the payment // method that was chosen for the // customer. // bValidatePay - Indicates whether the payment details // should be validated by the system. // sServiceName - The name of the contract service to // be purchased for the reseller. // Output: // CustomerOid - The created customer OID. // sErrorMsg - Error message where applicable. // // // Returns: // false - Failure. // true - Success. //******************************************************************* boolean RegisterCorpCust(in CorbaDof::Tuple tSecurity, in TransactionManager::HCONNECTION hConnection, in CorbaDof::Tuple tCustomer, in CorbaDof::Tuple tCSRService, in CorbaDof::Tuple tPayment, in boolean bValidatePay, in string sFatherExtId, out CorbaDof::OID CustomerOid, out string sErrorMsg); //******************************************************************* // Function : VerifyCustomerAddress // // Description: // This function verify the address inserted by the user. Currently support only // USA and Canada. If the address is ok, then the function return back the GeoCode, // which is a parameter that stores the address of the user and must be passed on to // create customer function. Every customer from USA and Canada must include the GeoCode // in order to calculate the taxes of his transactions. // // Parameters: // Input: // sState - Required param. Contains the state. // sCounty - Contains the customer county. This param can be null (empty string). // If the sCounty is empty or incorrect the output param tCounties // will contain a list of counties associated to the input State and Zip Code // sCity - Contains the customer city. This param can be null (empty string). // If the sCity is empty or incorrect the output param tCities // will contain a list of cities associated to the input State and Zip Code // sZipCode - Required param. Contains the customer zip code. // // // Output: // sGeoCode - If the input address is ok (state, county, city & zip code), sGeoCode will contain // the GeoCode that represent the customer address, otherwise it will be empty. // tCities - if the address is incorrect or empty, then tCities tuple will contain a list of Cities associated with // the input state and zip code // tCounties - if the address is incorrect or empty, then tCounties tuple will contain a list of Counties associated with // the input state and zip code // sErrorMsg - Error message where applicable. // // // Returns: // false - Failure. // true - Success. //******************************************************************* boolean VerifyCustomerAddress (in string sState, in string sCounty, in string sCity, in string sZipCode, out string sGeoCode, out CorbaDof::Tuple tCities, out CorbaDof::Tuple tCounties, out string sErrorMsg); //******************************************************************* // Function : GetCustomerProfile // // Description: // The function returnes the customer profile. // // Parameters: // Input: // hConnection - Database connection. Pass -1 if no connection // in use. // CustomerOid - The object identifier of the customer. // Output: // tProfile - The customer profile tuple // sErrorMsg - Error message where applicable. // // // Returns: // false - Failure. // true - Success. //******************************************************************* boolean GetCustomerProfile(in TransactionManager::HCONNECTION hConnection, in CorbaDof::OID CustomerOid, out CorbaDof::Tuple tProfile, out string sErrorMsg); //******************************************************************* // Function : GetNumOfNonBillableSons // // Description: // // Parameters: // hConnection - Database connection.Pass -1 if no connection // in use. // CustomerOid - The identifier of the Customer. // CustomerExtId - The identifier of the Customer. // tsEffectiveDate - The effective date of the hierarchy data // iNumOfNonBillableSons - // sErrorMsg - Error message where applicable. // // Returns: // false - Failure. // true - Success. //******************************************************************* boolean GetNumOfNonBillableSons(in TransactionManager::HCONNECTION hConnection, in CorbaDof::OID CustomerOid, in string CustomerExtId, in CorbaDof::Timestamp tsEffectiveDate, out long iNumOfNonBillableSons, out string sErrorMsg); //******************************************************************* //******************************************************************* // // BUSINESS PARTNER f u n c t i o n s // //******************************************************************* //******************************************************************* //******************************************************************* // Function : GetBusinessPartners // // Description: // The function returnes the all business partners. // // Parameters: // Input: // hConnection - Database connection. Pass -1 if no connection // in use. // Output: // tlPartners - The business partners list. // sErrorMsg - Error message where applicable. // // // Returns: // false - Failure. // true - Success. //******************************************************************* boolean GetBusinessPartners(in TransactionManager::HCONNECTION hConnection, out CorbaDof::TupleList tlPartners, out string sErrorMsg); //******************************************************************* // Function : GetPartnerAgreementTree // // Description: // The function returnes the tree of agreements in a form of // tuple list where the first roe is the business partner and // the following rows containing the service relevant details // and the service rules details when the service data is in // each row of the service rule. // Each row from second forward contains: // service_oid // service_name // service_desc // num_of_rules // service_rule_oid // service_rule_name // service_rule_desc // effective_date // event_obj_num // event_name // expiration_date // // Parameters: // Input: // hConnection - Database connection. Pass -1 if no connection // in use. // PartnerOid - The business partner oid. // Output: // tlTree - The tree-like tuple list. // sErrorMsg - Error message where applicable. // // Returns: // false - Failure. // true - Success. //******************************************************************* boolean GetPartnerAgreementTree(in TransactionManager::HCONNECTION hConnection, in CorbaDof::OID PartnerOid, out CorbaDof::TupleList tlTree, out string sErrorMsg); //******************************************************************* // Function : UpdateServicePartners // // Description: // The function updates all service related partner service rules. // // Parameters: // Input: // hConnection - Database connection. Pass -1 if no connection // in use. // ServiceOid - The service oid. // Output: // sErrorMsg - Error message where applicable. // // // Returns: // false - Failure. // true - Success. //******************************************************************* boolean UpdateServicePartners(in TransactionManager::HCONNECTION hConnection, in CorbaDof::OID ServiceOid, out string sErrorMsg); //******************************************************************* //******************************************************************* // // BUSINESS PARTNER f u n c t i o n s // //******************************************************************* //******************************************************************* //******************************************************************* //******************************************************************* // // CUST ACTION f u n c t i o n s // //******************************************************************* //******************************************************************* //******************************************************************* // Function : GetCustomerActionsList // Description: // Get all customer actions . // Parameters: // Input: // CustomerOID - Customer OID. // Output: // tlCustAction - List of all customer actions (without AVL). // tlAvl - List of all the customer actions AVLs. // tlExtraData - List of all the customer actions Extra Data AVLs // sErrorMsg - Error message. // // Returns: // true - SUCCESS. // false - FAILURE. //******************************************************************* boolean GetCustomerActionsList(in TransactionManager::HCONNECTION hConnection, in CorbaDof::OID CustomerOID, in long long llStartRow, in long lNumRows, out CorbaDof::TupleList tlCustAction, out CorbaDof::TupleList tlAvl, out CorbaDof::TupleList tlExtraData, out string sErrorMsg); //******************************************************************* // Function :GetCustomerAction // Description: // Get Customer action by Customer Action OID. // Parameters: // Input: // hConnection - Connection to DB. // CustActionOID - Customer Action OID. // Output: // tCustAction - Tuple that contain the customer action attributes // (without AVL). // tAvl - The customer action AVL . the AVL include all // the action parameters. // tExtraData - An additional data avl field. // sErrorMsg - Error Message. // // Returns: // true - SUCCESS. // false - FAILURE. //******************************************************************* boolean GetCustomerAction(in TransactionManager::HCONNECTION hConnection, in CorbaDof::OID CustActionOID, out CorbaDof::Tuple tCustAction, out CorbaDof::Tuple tAvl, out CorbaDof::Tuple tExtraData, out string sErrorMsg); //******************************************************************* // Function : CreateCustomerAction // Description: // Create customer action in the DB . // The tCustAction Tuple must include: // *Customer obj num // *Subscriber obj num // *Due date // *CSM_Action_Type_Obj_Num // Parameters: // tSecurity - Contining user id used to log the action. // hConnection - Connection to DB. // CustActionOID - Customer Action OID. // tCustAction - Tuple that contain the customer action attributes // that needed to the creation (without AVL). // tAvl - The customer action AVL . the AVL include all // the action parameters. // tExtraData - An additional data avl field. // sErrorMsg - Error Message. // Returns: // true - SUCCESS. // false - FAILURE. //******************************************************************* boolean CreateCustomerAction(in CorbaDof::Tuple tSecurity, in TransactionManager::HCONNECTION hConnection, inout CorbaDof::OID CustActionOID, in CorbaDof::Tuple tCustAction, in CorbaDof::Tuple tAvl, in CorbaDof::Tuple tExtraData, out string sErrorMsg); //******************************************************************* // Function :UpdateCustomerAction // Description: // Update customer Action. // The API updates the below parameters: // *Due Date, // *Status (only to cancelled), // *AVL, // *Remark // The API will not update the below parameters: // Customer obj num , Subscriber Obj Num ,CSM Action Type Obj Num // Last Trail Date, Error msg, Trail Num. // Parameters: // Input: /// tSecurity - Contining user id used to log the action. // hConnection - Connection to DB. // CustActionOID - Customer Action OID. // tCustAction - Tuple that contain the customer action attributes // that needed to the updating (without AVL) // tAvl - The customer action AVL . // tExtraData - An additional data avl field. // Output: // sErrorMsg - Error message // Returns: // true - SUCCESS. // false - FAILURE. //******************************************************************* boolean UpdateCustomerAction(in CorbaDof::Tuple tSecurity, in TransactionManager::HCONNECTION hConnection, in CorbaDof::OID CustActionOID, in CorbaDof::Tuple tCustAction, in CorbaDof::Tuple tAvl, in CorbaDof::Tuple tExtraData, out string sErrorMsg); //******************************************************************* // Function :DeleteCustomerAction // Description: Delete Action from DB. // Delete action is possible only to customer action with // status cancelled or pending. // Parameters: // Input: // tSecurity - Contining user id used to log the action. // hConnection - Connection to DB. // CustActionOID - Customer Action OID // Output // sErrorMsg - Error Message // // Returns: // true - SUCCESS. // false - FAILURE. //******************************************************************* boolean DeleteCustomerAction(in CorbaDof::Tuple tSecurity, in TransactionManager::HCONNECTION hConnection, in CorbaDof::OID CustActionOID, out string sErrorMsg); //******************************************************************* // Function :CancelCustomerAction // Description: // The API can update only the status and remark fields. // The status can changed only to cancelled status. // Parameters: // Input: // tSecurity - Contining user id used to log the action. // hConnection - Connection to DB. // CustActionOID - Customer Action OID // tCustAction - Tuple that contain the customer action attributes // that needed to the cancellation. // Output: // sErrorMsg - Error Message // Returns: // true - SUCCESS. // false - FAILURE. //******************************************************************* boolean CancelCustomerAction(in CorbaDof::Tuple tSecurity, in TransactionManager::HCONNECTION hConnection, in CorbaDof::OID CustActionOID, in CorbaDof::Tuple tCustAction, out string sErrorMsg); //******************************************************************* // Function :RerunCustomerAction // Description: // Rerun customer action if the CSM Action has rerun indication. // Parameters: // Input: // hConnection - Connection to DB. // CustActionOID - Customer Action OID // Output: // sErrorMsg - Error message // // Returns: // true - SUCCESS. // false - FAILURE. //******************************************************************* boolean RerunCustomerAction(in TransactionManager::HCONNECTION hConnection, in CorbaDof::OID CustActionOID, out string sErrorMsg); //******************************************************************* // Function :RerunAllCustomerAction // Description: // Rerun all customer actions .rerun is possible only if CSM action has // rerun indication // Parameters: // Input: // hConnection - Connection to DB. // CustomerOID - Customer OID. // Output: // sErrorMsg - Error Message. // Returns: // true - SUCCESS. // false - FAILURE. //******************************************************************* boolean RerunAllCustomerActions(in TransactionManager::HCONNECTION hConnection, in CorbaDof::OID CustomerOID, out string sErrorMsg); //******************************************************************* //******************************************************************* // // CSM ACTION TYPE f u n c t i o n s // //******************************************************************* //******************************************************************* // Get CSM Action Type //******************************************************************* // Function :GetCSMActionType // Description: // Get CSM Action Type by OID. // Parameters: // input: // hConnection - Connection to DB. // CSMActionTypeOID - CSM Action Type OID. // output: // tCSMActionType - Tuple of CSM Action Type without AVL // tParamAvl - AVL tuple that include the CSM Action // type parameters. // sErrorMsg - Error message // // Returns: // true - SUCCESS. // false - FAILURE. //******************************************************************* boolean GetCSMActionType(in TransactionManager::HCONNECTION hConnection, in CorbaDof::OID CSMActionTypeOID, out CorbaDof::Tuple tCSMActionType, out CorbaDof::Tuple tParamAvl, out string sErrorMsg); //******************************************************************* // Function :GetCSMActionTypeList // Description: // Get All CSM Actions type list // Parameters: // input // hConnection - Connection to DB // llStartRow - Start output row , default 0 // lNumRows - Number input rows , default 0 // output // tlCSMActionType - Tuple list that contain all the CSM Actions // types without the AVL parameters // tlParamAvl - The CSM Actions types AVL // sErrorMsg - Error message // Returns: // true - SUCCESS. // false - FAILURE. //*******************************************************************/ boolean GetCSMActionsTypeList(in TransactionManager::HCONNECTION hConnection, in long long llStartRow, in long lNumRows, out CorbaDof::TupleList tlCSMActionType, out CorbaDof::TupleList tlParamAvl, out string sErrorMsg); //******************************************************************* // Function : SyncCustomerPartition // // Description: // Syncronize Customer Partition // // Parameters: // Input: // hConnection - Database connection. Pass -1 if no connection // in use. // CustomerExternalId - The identifier of Customer. // Output: // sErrorMsg - Error message where applicable. // // // Returns: // false - Failure. // true - Success. //******************************************************************* boolean SyncCustomerPartition(in TransactionManager::HCONNECTION hConnection, in string ExternalCustId, out string sErrorMsg); //******************************************************************* // Function : ChangeCustomerPartition // // Description: // Change Customer Partition // // Parameters: // Input: // hConnection - Database connection. Pass -1 if no connection // in use. // CustomerExternalId - The identifier of Customer. // PartId - The identifier of partition // Output: // sErrorMsg - Error message where applicable. // // // Returns: // false - Failure. // true - Success. //******************************************************************* boolean ChangeCustomerPartition(in TransactionManager::HCONNECTION hConnection, in string ExternalCustId, in long PartId, out string sErrorMsg); // Get a list of customer banks for display (by Visibility Type). // If Subscriber_obj_num exists in the search tuple, the banks of this // only subscriber will be returned too. // (GetBankDisplayList function return all the subscribers banks) boolean GetCustomerBankDisplayList(in TransactionManager::HCONNECTION hConnection, in CorbaDof::Tuple tSearch, out CorbaDof::TupleList tlTxBanks, out CorbaDof::TupleList tlCyclicBanks, out string sErrorMsg, in boolean bCsrRequest); //******************************************************************* // Function : GetAvailableProductsbyProfile // // Description: // Gets the list of all the available products of an user according to its profile // that can be added to a particular subscriber // These products are the ones that hasn't purchased by the subscriber and are // not restricted by the user profile. (not contained in the table PROFILE_PRODUCT_RESTRICT) // // Parameters: // Input: // hConnection - Database connection. Pass -1 if no connection // in use. // tSecurity - A security tuple that is used to identify the user // whose available procucts according its to profile that can be purchased for a particular // subscrbirer should be fetched. // This tuple must contain 'UserId' element populating a valid CSR user name. // SubscriberOid The OID of the relevant subscriber for which producys should be purchased // Output: // tlProducts - The relevant available products // tlProductRelations - The existing relations between the products. (Including ones that can't // available to the current user but can effect on purchasing available ones) // // sErrorMsg - Error message where applicable. // Returns: // false - Failure. // true - Success. ////////////////////////////////////////////////////////////////////////////////////////////////// boolean GetAvailableProductsbyProfile(in TransactionManager::HCONNECTION hConnection, in CorbaDof::Tuple tSecurity, in CorbaDof::OID SubscriberOid, out CorbaDof::TupleList tlProducts, out CorbaDof::TupleList tlProductRelations, out string sErrorMsg); //******************************************************************* // // CHANGE MARKET FUNCTIONS // //******************************************************************* //******************************************************************* // Function: ValidateCustMarketAttributes // // Description: // Checks if the customer's payment method and invoice type can remain unchanged // in case the customer is moved to a given destination market. // Otherwise, propose lists of available in the destination market // payment methods and invoice types. // // Parameters: // Input: // hConnection - DB connection. Can be read-only. // Pass -1 to execute in a separate transaction. // CustomerOid - The customer's identifier. // If not provided - sExternalCustId will be used instead. // sExternalCustId - The external ID of the customer. // Will be used only if CustomerOid is not provided. // onDestinationMarketObjNum - The object number of the destination market. // // Output: // bValid - If the current customer's attributes // can remain as is in the new market. // tlPaymentMethods - List of PaymentMethod tuples // available in the destination market. // tlInvoiceTypes - List of InvoceType tuples // available in the destination market. // tlResellers - List of available resellers in the destination market // tlMissingProducts - List of missing products in the destination market when applicable // sErrorMsg - Returned error message. // // Returns: // false - Failure. // true - Success. //******************************************************************* boolean ValidateCustMarketAttributes(in TransactionManager::HCONNECTION hConnection, in CorbaDof::OID CustomerOid, in string sExternalCustId, in CorbaDof::ObjectNumber oDestinationMarketObjNum, out boolean bValid, out CorbaDof::TupleList tlPaymentMethods, out CorbaDof::TupleList tlInvoiceTypes, out CorbaDof::TupleList tlResellers, out CorbaDof::TupleList tlMissingProducts, out string sErrorMsg); //******************************************************************* // Function: GetMarketsForChangeMarket // // Description: // Get the list of markets which are suitable destinations for changing customer's market. // Will return empty list also in case the customer itself // can not be moved out of its current market, regardless of any target market. // sErrorMsg will contain a description of why the customer can not be moved. // // Parameters: // Input: // hConnection - DB connection. Can be read-only. // Pass -1 to execute in a separate transaction. // CustomerOid - The customer's identifier. // If not provided - sExternalCustId will be used instead // sExternalCustId - The external ID of the customer. // Will be used only if CustomerOid is not provided. // // Output: // tlDestinationMarkets - List of Market tuples, which are suitable destinations. // sErrorMsg - Returned error message. // // Returns: // false - Failure. // true - Success. //******************************************************************* boolean GetMarketsForChangeMarket( in CorbaDof::Tuple tSecurity, in TransactionManager::HCONNECTION hConnection, in CorbaDof::OID CustomerOid, in string sExternalCustId, out CorbaDof::TupleList tlDestinationMarkets, out string sErrorMsg); //******************************************************************* // Function: RequestCustomerMarketChange // // Description: // This method creates a request for a customer market change. // The request is to be fulfilled after the EOC following certain date. // // Parameters: // Input: // tSecurity - Security tuple. // hConnection - DB connection. Must be read-write. // Pass -1 to execute in a separate transaction. // CustomerOid - The customer's identifier. // If not provided - sExternalCustId will be used instead. // sExternalCustId - The external ID of the customer. // Will be used only if CustomerOid is not provided. // tChangingCustomerData - The data which should change during the market change: // - "market_obj_num" - the new market; // - "invoice_type_obj_num" - the new invoice type; // - "payment_method_obj_num" - the new payment method. // - "reseller_obj_num" - the new reseller // // tsDueDate - The date after which the market change // is allowed to take place. // // Output: // sErrorMsg - Returned error message. // // Returns: // false - Failure. // true - Success. //******************************************************************* boolean RequestCustomerMarketChange( in CorbaDof::Tuple tSecurity, in TransactionManager::HCONNECTION hConnection, in CorbaDof::OID CustomerOid, in string sExternalCustId, in CorbaDof::Tuple tChangingCustomerData, in CorbaDof::Tuple tPaymentDetails, in CorbaDof::Timestamp tsDueDate, out string sErrorMsg); }; #endif