com.oracle.communications.brm.cc.modules

Interface DepositModule

All Superinterfaces:

BaseModule

All Known Implementing Classes:

PCMDepositModule

public interface DepositModule
extends BaseModule

This class is the interface for implementing Deposit Module

Method Summary

Modifier and Type	Method and Description
String	addDepositRefund(DepositRefund depositRefund) Creates Deposit Refund by validating the request, converting the JSON/XML to FList and invoking the Deposit refund opcode
String	addDepositRelease(DepositRelease depositRelease) Creates Deposit Release by validating the request, converting the JSON/XML to FList and invoking the Deposit release opcode
String	addDepositReversal(DepositReversal depositReversal) Creates Deposit Reversal by validating the request, converting the JSON/XML to FList and invoking the Deposit Reversal opcode
String	addDepositSpec(DepositSpec depositSpec) Creates Deposit Spec by validating the request, converting the JSON/XML to FList and invoking the Deposit Spec opcode
DepositAOC	adviceChargeCustomerDeposit(DepositAOC depositAOC) Creates advice of Charge Customer Deposit by validating the request, converting the JSON/XML to FList and invoking the advice of Charge Customer Deposit opcode
String	createCustomerDepositByOrder(DepositOrder depositOrder) Creates Customer Deposit by Order by validating the request, converting the JSON/XML to FList and invoking the Customer Deposit opcode
String	createDepositPayment(DepositPayments depositPayment) Creates Deposit Payment by validating the request, converting the JSON/XML to FList and invoking the DepositPayment opcode
String	createDepositSpecProfile(DepositSpecProfile depositSpecProfile) Creates Deposit Spec Profile by validating the request, converting the JSON/XML to FList and invoking the Deposit Spec Profile opcode
String	createDepositTransfer(DepositTransfer depositTransfer) Creates Deposit Transfer by validating the request, converting the JSON/XML to FList and invoking the Deposit Transfer opcode
DepositSpec	deleteDepositSpecById(String id) Delete Deposit Spec by id and invoking the deleteDepositSpecByIdInBRM opcode
List<InstallmentChargeOffer>	getChargeOffer(String category) Retrieve getChargeOffer by converting the input category and invoking the readObj opcode
CustomerDeposit	getCustomerDepositById(String id) Retrieves Customer Deposit by converting the input CustomerDeposit ID and invoking the readObj opcode
List<CustomerDeposit>	getCustomerDepositByQP(String serviceRef, String customerRef, String billProfileRef, String limit) Retrieves Customer Deposit order by converting the input Deposit ID and invoking the readObj opcode
List<DepositSpec>	getDeposiSpecByQP(String name, String status, String profileRef, String permitted, String profileName, String expiresAt, String limit) Retrieves Deposit Spec by converting the input name, status, profileRef, permitted, profileName, expiresAt and invoking the invokeGetDepositSpec opcode
DepositRefund	getDepositRefundById(String id) Retrieves Deposit Refund by converting the input DepositRefund ID and invoking the readObj opcode
List<DepositRefund>	getDepositRefundByQP(String customerRef, String serviceRef, String status, String customerNo, String limit) Retrieves Deposit Refund by converting the input DepositRefund customerNo, serviceRef, customerRef, status and invoking the readObj opcode
DepositSpec	getDepositSpecById(String id) Retrieves Deposit Spec by converting the input DepositSpec ID and invoking the readObj opcode
List<DepositSpecProfile>	getDepositSpecProfile(String id) Retrieves Deposit Spec Profile by converting the input DepositSpecProfile ID and invoking the readObj opcode
List<DepositSpecProfile>	getDepositSpecProfile(String status, String name, String expiresAt, String limit) Retrieves Deposit Spec Profile by converting the input status, name, expiresAt and invoking the readObj opcode
DepositTxn	getDepositTxnById(String id) Retrieves Deposit Transaction by converting the input Deposit ID and invoking the readObj opcode
List<DepositTxn>	getDepositTxnDetails(String customerDepositRef, String skip, String limit) Retrieves DepositTxn Details by converting the input DepositTxn customerDepositRef, limit and invoking the opcode
List<Plan>	getPlans() Retrieves Plan to invoking the invokePlans opcode
String	updateCustomerDepositById(DepositOrder depositOrder, String id) Update Customer Deposit by validating the request, converting the JSON/XML to FList and invoking the Customer Deposit opcode
String	updateDepositRefund(DepositRefund depositRefund, String id) Update Deposit Refund by validating the request, converting the JSON/XML to FList and invoking the Deposit refund opcode
String	updateDepositSpecById(DepositSpec depositSpec, String id) Update Deposit Spec by validating the request, converting the JSON/XML to FList and invoking the Deposit Spec opcode
String	updateDepositSpecProfile(DepositSpecProfile deposit, String id) Update Deposit Spec Profile by validating the request, converting the JSON/XML to FList and invoking the Deposit Spec Profile opcode

Methods inherited from interface com.oracle.communications.brm.cc.modules.BaseModule

getBaseOps, getURIContext, getUserContext, setBaseOps, setURIContext, setUserContext

Method Detail

createDepositSpecProfile

String createDepositSpecProfile(DepositSpecProfile depositSpecProfile)

Creates Deposit Spec Profile by validating the request, converting the JSON/XML to FList and invoking the Deposit Spec Profile opcode

Parameters:

depositSpecProfile - payload representing DepositSpecProfile schema

Returns:

String Deposit Spec Profile ID is returned on success;exception will be raised on failure.

getDepositSpecProfile

List<DepositSpecProfile> getDepositSpecProfile(String id)

Retrieves Deposit Spec Profile by converting the input DepositSpecProfile ID and invoking the readObj opcode

Parameters:

id - DepositSpecProfile ID example 0.0.0.1+-deposit_specification_profile+1571684

Returns:

getDepositSpecProfile payload represented by DepositSpecProfile Schema is returned on success;exception will be raised on failure.

getDepositSpecProfile

List<DepositSpecProfile> getDepositSpecProfile(String status,
                                               String name,
                                               String expiresAt,
                                               String limit)

Retrieves Deposit Spec Profile by converting the input status, name, expiresAt and invoking the readObj opcode

Parameters:

status -

name -

expiresAt - DepositSpecProfile ID example 0.0.0.1+-deposit_specification_profile+1571684

limit -

Returns:

getDepositSpecProfile payload represented by DepositSpecProfile Schema is returned on success;exception will be raised on failure.

updateDepositSpecProfile

String updateDepositSpecProfile(DepositSpecProfile deposit,
                                String id)

Update Deposit Spec Profile by validating the request, converting the JSON/XML to FList and invoking the Deposit Spec Profile opcode

Parameters:

deposit -

id - payload representing DepositSpecProfile schema

Returns:

String Deposit Spec Profile ID is returned on success;exception will be raised on failure.

getDepositSpecById

DepositSpec getDepositSpecById(String id)

Retrieves Deposit Spec by converting the input DepositSpec ID and invoking the readObj opcode

Parameters:

id - DepositSpec ID example 0.0.0.1+-deposit_specification+1571684

Returns:

getDepositSpec payload represented by DepositSpec Schema is returned on success;exception will be raised on failure.

updateDepositSpecById

String updateDepositSpecById(DepositSpec depositSpec,
                             String id)

Update Deposit Spec by validating the request, converting the JSON/XML to FList and invoking the Deposit Spec opcode

Parameters:

depositSpec, -

id - payload representing DepositSpec schema

Returns:

string Deposit Spec ID is returned on success;exception will be raised on failure.

addDepositSpec

String addDepositSpec(DepositSpec depositSpec)

Creates Deposit Spec by validating the request, converting the JSON/XML to FList and invoking the Deposit Spec opcode

Parameters:

depositSpec - payload representing DepositSpec schema

Returns:

string Deposit Spec ID is returned on success;exception will be raised on failure.

getDeposiSpecByQP

List<DepositSpec> getDeposiSpecByQP(String name,
                                    String status,
                                    String profileRef,
                                    String permitted,
                                    String profileName,
                                    String expiresAt,
                                    String limit)

Retrieves Deposit Spec by converting the input name, status, profileRef, permitted, profileName, expiresAt and invoking the invokeGetDepositSpec opcode

Parameters:

name -

status -

profileRef -

permitted -

profileName -

expiresAt - DepositSpec example 0.0.0.1+-deposit_specification+1571684

limit -

Returns:

getDepositSpec payload represented by DepositSpec Schema is returned on success;exception will be raised on failure.

deleteDepositSpecById

DepositSpec deleteDepositSpecById(String id)

Delete Deposit Spec by id and invoking the deleteDepositSpecByIdInBRM opcode

Parameters:

id - DepositSpec ID example 0.0.0.1+-deposit_specification+1571684

Returns:

DepositSpec payload represented by DepositSpec Schema is returned on success;exception will be raised on failure.

addDepositRelease

String addDepositRelease(DepositRelease depositRelease)

Creates Deposit Release by validating the request, converting the JSON/XML to FList and invoking the Deposit release opcode

Parameters:

depositRelease - payload representing DepositRelease schema

Returns:

string Deposit release ID is returned on success;exception will be raised on failure.

getChargeOffer

List<InstallmentChargeOffer> getChargeOffer(String category)

Retrieve getChargeOffer by converting the input category and invoking the readObj opcode

Parameters:

category -

Returns:

getChargeOffer payload represented by InstallmentChargeOffer Schema is returned on success;exception will be raised on failure.

getPlans

List<Plan> getPlans()

Retrieves Plan to invoking the invokePlans opcode

Returns:

packageList payload represented by Plan Schema is returned on success;exception will be raised on failure.

addDepositRefund

String addDepositRefund(DepositRefund depositRefund)

Creates Deposit Refund by validating the request, converting the JSON/XML to FList and invoking the Deposit refund opcode

Parameters:

depositRefund - payload representing DepositRefund schema

Returns:

responseId Deposit refund ID is returned on success;exception will be raised on failure.

updateDepositRefund

String updateDepositRefund(DepositRefund depositRefund,
                           String id)

Update Deposit Refund by validating the request, converting the JSON/XML to FList and invoking the Deposit refund opcode

Parameters:

depositRefund -

id - payload representing DepositRefund schema

Returns:

responseId Deposit refund ID is returned on success;exception will be raised on failure.

getDepositRefundById

DepositRefund getDepositRefundById(String id)

Retrieves Deposit Refund by converting the input DepositRefund ID and invoking the readObj opcode

Parameters:

id - DepositRefund ID example 0.0.0.1+-deposit_refund_request+1875897

Returns:

getDepositRefund payload represented by DepositRefund Schema is returned on success;exception will be raised on failure.

getDepositRefundByQP

List<DepositRefund> getDepositRefundByQP(String customerRef,
                                         String serviceRef,
                                         String status,
                                         String customerNo,
                                         String limit)

Retrieves Deposit Refund by converting the input DepositRefund customerNo, serviceRef, customerRef, status and invoking the readObj opcode

Parameters:

customerNo -

serviceRef -

customerRef -

status - example 0.0.0.1+-deposit_refund_request+1875897

Returns:

depositRefund payload represented by DepositRefund Schema is returned on success;exception will be raised on failure.

addDepositReversal

String addDepositReversal(DepositReversal depositReversal)

Creates Deposit Reversal by validating the request, converting the JSON/XML to FList and invoking the Deposit Reversal opcode

Parameters:

depositReversal - payload representing DepositReversal schema

Returns:

string Deposit Reversal ID is returned on success;exception will be raised on failure.

createDepositTransfer

String createDepositTransfer(DepositTransfer depositTransfer)

Creates Deposit Transfer by validating the request, converting the JSON/XML to FList and invoking the Deposit Transfer opcode

Parameters:

depositTransfer - representing DepositTransfer schema

Returns:

string Deposit transfer ID is returned on success;exception will be raised on failure.

createCustomerDepositByOrder

String createCustomerDepositByOrder(DepositOrder depositOrder)

Creates Customer Deposit by Order by validating the request, converting the JSON/XML to FList and invoking the Customer Deposit opcode

Parameters:

depositOrder - payload representing DepositOrder schema

Returns:

string Deposit order ID is returned on success;exception will be raised on failure.

getCustomerDepositByQP

List<CustomerDeposit> getCustomerDepositByQP(String serviceRef,
                                             String customerRef,
                                             String billProfileRef,
                                             String limit)

Retrieves Customer Deposit order by converting the input Deposit ID and invoking the readObj opcode

Parameters:

serviceRef -

customerRef -

billProfileRef -

limit - 0.0.0.1+-purchased_deposit+1571684

Returns:

getCustomerDeposit payload represented by CustomerDeposit Schema is returned on success;exception will be raised on failure.

getCustomerDepositById

CustomerDeposit getCustomerDepositById(String id)

Retrieves Customer Deposit by converting the input CustomerDeposit ID and invoking the readObj opcode

Parameters:

id - CustomerDeposit ID example 0.0.0.1+-purchased_deposit+1571684

Returns:

getCustomerDepositById payload represented by CustomerDeposit Schema is returned on success;exception will be raised on failure.

adviceChargeCustomerDeposit

DepositAOC adviceChargeCustomerDeposit(DepositAOC depositAOC)

Creates advice of Charge Customer Deposit by validating the request, converting the JSON/XML to FList and invoking the advice of Charge Customer Deposit opcode

Parameters:

depositAOC - payload representing DepositAOC schema

Returns:

string Deposit advice of Charge ID is returned on success;exception will be raised on failure.

updateCustomerDepositById

String updateCustomerDepositById(DepositOrder depositOrder,
                                 String id)

Update Customer Deposit by validating the request, converting the JSON/XML to FList and invoking the Customer Deposit opcode

Parameters:

depositOrder -

id - payload representing DepositOrder schema

Returns:

string DepositOrder ID is returned on success;exception will be raised on failure.

getDepositTxnById

DepositTxn getDepositTxnById(String id)

Retrieves Deposit Transaction by converting the input Deposit ID and invoking the readObj opcode

Parameters:

id - Deposit ID example

Returns:

getDepositTxn payload represented by DepositTxn Schema is returned on success;exception will be raised on failure.

createDepositPayment

String createDepositPayment(DepositPayments depositPayment)

Creates Deposit Payment by validating the request, converting the JSON/XML to FList and invoking the DepositPayment opcode

Parameters:

depositPayment - payload representing DepositPayments schema

Returns:

string Deposit Payment ID is returned on success;exception will be raised on failure.

getDepositTxnDetails

List<DepositTxn> getDepositTxnDetails(String customerDepositRef,
                                      String skip,
                                      String limit)

Retrieves DepositTxn Details by converting the input DepositTxn customerDepositRef, limit and invoking the opcode

Parameters:

customerDepositRef - example 0.0.0.1+-purchased_deposit+1875897

limit - example 10

skip - Position of start of the next search results

Returns:

depositTxn payload represented by DepositTxn Schema is returned on success;exception will be raised on failure.