Release 1.34

CreateInvoicePayment

com.cdrator.billing.invoice.action.CreateInvoicePayment

9.7

Create, save and return a new InvoicePayments object with the provided information.

InvoicePayments: The created InvoicePayments object

1. Invoice: invoice
2. PersistentObject: balancingObject
3. Amount: amount
4. Date: paymentDate
5. String: paymentTypeId
6. String: reference
7. String: sourceDescription

IsBNumberInBNumberList

com.cdrator.billing.rating.bnumberregistration.action.IsBNumberInBNumberList

9.7

Return whether a B-number is in the list

boolean: null

1. BNumberCategoryKey: B-number category key
2. BNumberProviderClassName: B-number provider class

1. String: bNumber
2. BNumberAssignable: bNumberAssignable
3. Date: onDate

GetBrandByKeyAction

com.cdrator.brand.action.GetBrandByKeyAction

9.7

Returns a Brand with a given key

Brand: null

1. brandKey: Brand key

GetAccountPaymentCleanUpTransaction

com.cdrator.billing.payment.action.GetAccountPaymentCleanUpTransaction

9.6

Create an AccountPaymentCleanUpTransaction based on an accountPayment and a paymentGatewayTransactionLogger

AccountPaymentCleanUpTransaction: The created AccountPaymentCleanUpTransaction

1. AccountPayment: accountPayment

PreviewSubscriptionFeeBillResult

com.cdrator.billing.subscriptionFees.action.PreviewSubscriptionFeeBillResult

9.6

Execute a preview on a subscription fee

PreviewInvocationResult: PreviewInvocationResult from the preview

1. SubscriptionFees: subscriptionFee

BuildAccountPaymentRequestForInvoicesOnBatch

com.cdrator.billing.financial.billing.action.BuildAccountPaymentRequestForInvoicesOnBatch

9.5

Creates an account payment request for all invoices in a batch. To have the account payment request created, the payment_method_id on the billing group must match the payment method found by the key provided as paymentMethodKey.

void: Nothing is returned.

1. paymentType: The account payment request type that should be used for the payment.

1. InvoiceBatch: batch
2. String: paymentMethodKey

PreviewSubscriptionFee

com.cdrator.billing.subscriptionFees.action.PreviewSubscriptionFee

9.5

Execute a preview on a subscription fee

PreviewInvocationResult: PreviewInvocationResult from the preview

1. SubscriptionFees: subscriptionFee

CalculateTotalFeeForPreview

com.cdrator.billing.support.preview.action.CalculateTotalFeeForPreview

9.5

Calculates the total fee based on a PreviewInvocationResult

Amount: The total fee

1. PreviewInvocationResult: previewInvocationResult

GetNumberPlanFromRatePlanAndServiceCode

com.cdrator.billing.rating.action.GetNumberPlanFromRatePlanAndServiceCode

9.4

Gets a number plan from the rateplan and service code, if no number plan is found, null is returned.

NumberPlan: null

1. RatePlan: ratePlan
2. Date: date
3. String: serviceCode

CreateNpMessage

com.cdrator.np.action.CreateNpMessage

9.4

Uses the Np message builder to create an Np message for either IN or OUT porting.

NpMessage: null

1. npMessageDirection: Direction of np message.

1. String: npFlowID
2. String: code
3. String: message
4. Date: startDate

CreateWallet

com.cdrator.billing.financial.payments.wallet.action.CreateWallet

8.21

Create a wallet

Wallet: The resulting wallet

1. WalletHolder: walletHolder
2. Currency: currency
3. String: name
4. ChargeItem: chargeItem

DepositToWallet

com.cdrator.billing.financial.payments.wallet.action.DepositToWallet

8.21

Deposit amount to wallet and transfer from the billing group

WalletTransaction: The resulting wallet transaction

1. Wallet: wallet
2. BillingGroup: billingGroup
3. Amount: amount

GetWalletByName

com.cdrator.billing.financial.payments.wallet.action.GetWalletByName

8.21

Retrieves a wallet based on the wallet name. If wallet name is null, the default name is used

Wallet: The wallet associated with the holder and the wallet name. If no wallet is found, null is returned

1. WalletHolder: walletHolder
2. String: walletName

WithdrawFromWallet

com.cdrator.billing.financial.payments.wallet.action.WithdrawFromWallet

8.21

Withdraw amount from wallet and transfer to the billing group

WalletTransaction: The resulting wallet transaction

1. Wallet: wallet
2. BillingGroup: billingGroup
3. Amount: amount

CreateCapturedAccountPayment

com.cdrator.billing.financial.billing.action.CreateCapturedAccountPayment

8.19

Creates a captured account payment

AccountPayment: null

1. Amount: amount
2. Currency: currency
3. String: reference
4. String: transactionNumber
5. BillingGroup: billingGroup
6. Date: paymentDate
7. AccountPaymentType: accountPaymentType
8. Invoice: invoice

HandleAccountPayment

com.cdrator.billing.financial.payments.action.HandleAccountPayment

8.19

null

PaymentResult: null

1. action: Action to be executed

1. AccountPayment: accountPayment

GetCustomAttribute

com.cdrator.customAttribute.action.GetCustomAttribute

8.19

Gets a custom attribute from the database, it is returned as the kind of object that the property definition is set to. (string, date, amount, boolean or persisten object.

Object: null

1. PersistentObject: object
2. String: columnName

SetCustomAttribute

com.cdrator.customAttribute.action.SetCustomAttribute

8.19

Set the value of a custom attribute

void: null

1. saveObject: Sets if the object should be saved.

1. PersistentObject: object
2. String: columnName
3. Object: value

GenericOrderLineReader

com.cdrator.order.action.GenericOrderLineReader

8.19

Retrieves a Device based on configurable parameters

PersistentObject: Retrieves the a persistent object based on the constraints from the properties and parameters.

1. attributeName1: Attribute 1
2. attributeName2: Attribute 2
3. attributeName3: Attribute 3

1. Object: constraint1
2. Object: constraint2
3. Object: constraint3

GenericOrderReader

com.cdrator.order.action.GenericOrderReader

8.19

Retrieves a Device based on configurable parameters

PersistentObject: Retrieves the a persistent object based on the constraints from the properties and parameters.

1. attributeName1: Attribute 1
2. attributeName2: Attribute 2
3. attributeName3: Attribute 3

1. Object: constraint1
2. Object: constraint2
3. Object: constraint3

AddCalendarDaysToDate

com.cdrator.util.date.action.AddCalendarDaysToDate

8.19

Adds a number of days to a date. Only free days in the calendar counts. If the given base date is not valid according to the calendar and 0 days are added, then the first valid date is returned.

Date: Returns the first available date according to the calendar, after adding a number of days

1. calendarKey: Calendar key
2. resetTime: Reset time on the returned date?

1. Date: baseDate
2. int: numberOfDaysToAdd

CreateAccountPaymentsIfInvoicedBillingGroupHasRechargeTicket

com.cdrator.billing.invoicebatch.action.CreateAccountPaymentsIfInvoicedBillingGroupHasRechargeTicket

8.18

Creates account payments for invoices where the related billing group has a recharge ticket

void: No return value

1. authorized: Created account payment is set authorized.
2. captured: Created account payment is set auhorized, doCapture and captured.
3. doCapture: Created account payment is set authorized and set doCapture.
4. paymentType: Account payment type that should be used for the payment.

1. InvoiceBatch: invoiceBatch

DeleteRechargeTicketUsingRemover

com.cdrator.billing.payment.action.DeleteRechargeTicketUsingRemover

8.18

This action deletes a recharge ticket from the system using the RechargeTicketRemover (inovokes hookpoint RECHARGETICKET.BEFORE.DELETE). A history line is created with information about the deleted recharge ticket.

void: Nothing is returned.

1. RechargeTicket: rechargeTicket

CreateSubscriptionCampaignMember

com.cdrator.campaign.action.CreateSubscriptionCampaignMember

8.18

Retrieves a service based on configurable parameters.

SubscriptionCampaignMember: null

1. SubscriptionCampaign: subscriptionCampaign
2. SubscriptionCampaignSharingGroup: targetObject
3. Date: startDate
4. Date: endDate

ExpireSubscriptionCampaignMember

com.cdrator.campaign.action.ExpireSubscriptionCampaignMember

8.18

null

void: null

1. SubscriptionCampaignMember: subscriptionCampaignMember
2. Date: endDate

GetSubscriptionCampaignMember

com.cdrator.campaign.action.GetSubscriptionCampaignMember

8.18

Retrieves a subscription campaign member

SubscriptionCampaignMember: null

1. SubscriptionCampaign: subscriptionCampaign
2. SubscriptionCampaignSharingGroup: subscriptionCampaignSharingGroup
3. Date: date

ActivateSubscriptionCampaigns

com.cdrator.campaign.action.ActivateSubscriptionCampaigns

8.15

Activate all subscription campaigns in initial status on the given subscription. To filter which subscription campaigns to activate you can provide optional list of campaigns otherwise all will be activated. If start date is specified then it will overwrite default one which is now.

void: No return value

1. Subscription: subscription
2. List: campaigns
3. Date: activationDate

ExpireSubscriptionCampaignNow

com.cdrator.campaign.action.ExpireSubscriptionCampaignNow

8.15

Expires the Subscription Campaign using the core logic. Default core logic will only changes the status of the Subscription Campaign to expired. End date will not be changed. Gives UnableToExpireCampaignException if the campaign could not be expired.

SubscriptionCampaignTransitionOutput: The transition output of the expire campaign event.

1. SubscriptionCampaign: subscriptionCampaign

UnsubscribeCampaignToDate

com.cdrator.campaign.action.UnsubscribeCampaignToDate

8.15

Unsubscribes a campaign to a specific end date

void: No return value

1. SubscriptionCampaign: subscriptionCampaign
2. Date: endDate

CreateBundleTypeSummary

com.cdrator.campaign.bundle.action.CreateBundleTypeSummary

8.15

Returns a list of bundle type summaries of type Context. One bundle type summary is created for each bundle code in the provided subscription bundle list

ArrayList: A list of Context objects representing summary of bundle types.

1. bundleCodes: A semicolon seperated list of bundle codes to create summaries for.

1. ArrayList: subscriptionBundles

RemoveContextObject

com.cdrator.workflow.context.action.RemoveContextObject

8.15

Removes an object from context using its key

void: No return value

1. WfContext: context
2. String: objectKey

BillingCycleAdvancedReader

com.cdrator.billing.billingcycle.action.BillingCycleAdvancedReader

8.7

Retrieves billing cycles based on configurable parameters.

Object: Retrieves a unique or list of persistent objects based on the constraints and operators from the properties and parameters.

1. attributeName1: Attribute 1
2. attributeName2: Attribute 2
3. attributeName3: Attribute 3
4. getList: Return a single value (default) or a list of values
5. operator1: Operator 1
6. operator2: Operator 2
7. operator3: Operator 3

1. Object: constraint1
2. Object: constraint2
3. Object: constraint3

BillingCycleReader

com.cdrator.billing.billingcycle.action.BillingCycleReader

8.7

Retrieves a Billing Cycle based on configurable parameters.

PersistentObject: Retrieves the a persistent object based on the constraints from the properties and parameters.

1. attributeName1: Attribute 1
2. attributeName2: Attribute 2
3. attributeName3: Attribute 3

1. Object: constraint1
2. Object: constraint2
3. Object: constraint3

GetEndOfBillingCycleDate

com.cdrator.billing.billingcycle.action.GetEndOfBillingCycleDate

8.7

This action returns a date representing the last day of the current billing cycle for the given billing group.

Date: A Date representing the last day of the current billing cycle.

1. Date: date
2. BillingGroup: bg

BillingGroupActiveSubscriptionCounter

com.cdrator.billing.billinggroup.action.BillingGroupActiveSubscriptionCounter

8.7

Counts no. of active subscription on a billing group.

int: This returns the no. of active subscription on a billing group.

1. BillingGroup: bg

BillingGroupAdvancedReader

com.cdrator.billing.billinggroup.action.BillingGroupAdvancedReader

8.7

Retrieves billing groups based on configurable parameters.

Object: Retrieves a unique or list of persistent objects based on the constraints and operators from the properties and parameters.

1. attributeName1: Attribute 1
2. attributeName2: Attribute 2
3. attributeName3: Attribute 3
4. getList: Return a single value (default) or a list of values
5. operator1: Operator 1
6. operator2: Operator 2
7. operator3: Operator 3

1. Object: constraint1
2. Object: constraint2
3. Object: constraint3

BillingGroupReader

com.cdrator.billing.billinggroup.action.BillingGroupReader

8.7

Retrieves a Billing Group based on configurable parameters

PersistentObject: Retrieves the a persistent object based on the constraints from the properties and parameters.

1. attributeName1: Attribute 1
2. attributeName2: Attribute 2
3. attributeName3: Attribute 3

1. Object: constraint1
2. Object: constraint2
3. Object: constraint3

BillingGroupSetter

com.cdrator.billing.billinggroup.action.BillingGroupSetter

8.7

Sets an attribute of Billing Group

void: Sets an attribute of a persistent object

1. attributeName: Attribute that should be set on the persistent object

1. PersistentObject: persistentObject
2. Object: value

GetActiveBillingGroupMembers

com.cdrator.billing.billinggroup.action.GetActiveBillingGroupMembers

8.7

Retrieves the active members of the billing group

List: The active members of the billing group

1. BillingGroup: billingGroup

HardBlockAllTeleServicesOnBillingGroup

com.cdrator.billing.billinggroup.action.HardBlockAllTeleServicesOnBillingGroup

8.7

This action attempts to hard block all teleservices on a billinggroup. First it verifies if they can be blocked. It will then add a history record with the supplied historyLine string if specified. Leave it blank to ommit a history line.

void: null

1. historyTag: Add translation tag for the history line if needed

1. BillingGroup: billingGroup
2. String: historyLine

SetBillingGroupAlertGroupId

com.cdrator.billing.billinggroup.action.SetBillingGroupAlertGroupId

8.7

Set the alertGroupId on billing group.

void: Returns nothing.

1. BillingGroup: bg
2. String: defaultAlertGroupId

SetBillingGroupAutoPaymentMaxAmount

com.cdrator.billing.billinggroup.action.SetBillingGroupAutoPaymentMaxAmount

8.7

Set the autoPaymentMaxAmount on billing group.

void: Returns nothing.

1. autoPaymentMaxAmount: The maximum auto payment amount.

1. BillingGroup: bg

SoftBlockAllTeleServicesOnBillingGroup

com.cdrator.billing.billinggroup.action.SoftBlockAllTeleServicesOnBillingGroup

8.7

This action attempts to block all teleservices on a billinggroup. First it verifies if they can be blocked. It will then add a history record with the supplied historyLine string if specified. Leave it blank to ommit a history line.

void: null

1. historyTag: Add translation tag for the history line if needed

1. BillingGroup: billingGroup
2. String: historyLine

UnBlockAllTeleServicesOnBillingGroup

com.cdrator.billing.billinggroup.action.UnBlockAllTeleServicesOnBillingGroup

8.7

This action attempts to unblock all teleservices on a billinggroup. First it verifies if they can be unblocked. Unblock type depends on the type of blocking used (hardblocked or softblocked) It will then add a history record with the supplied historyLine string if specified. Leave it blank to ommit a history line.

void: null

1. historyTag: Add translation tag for the history line if needed

1. BillingGroup: billingGroup
2. String: historyLine

CreateSingleChargeForBillingGroup

com.cdrator.billing.charge.action.CreateSingleChargeForBillingGroup

8.7

Creates and saves a Charge for a Billing Group. Adding the charge directly is optional, and if selected will create invoice detail lines directly.Adding description and amount is also optional, and if not specified, the amount and description will be default to the ones specified on the Charge Item fields.

Charge: The created charge is returned.

1. addCharge: If the charge should be added now. Default is false to let the Charge Engine pick it up instead.

1. BillingGroup: billingGroup
2. ChargeItem: chargeItem
3. String: description
4. Amount: amount

CreateSingleChargeForSubscription

com.cdrator.billing.charge.action.CreateSingleChargeForSubscription

8.7

Creates and saves a Charge for a Subscription. Adding the charge directly is optional, and if selected will create invoice detail lines directly.Adding description and amount is also optional, and if not specified, the amount and description will be default to the ones specified on the Charge Item fields.

Charge: The created charge is returned.

1. addCharge: If the charge should be added now. Default is false to let the Charge Engine pick it up instead.

1. Subscription: subscription
2. ChargeItem: chargeItem
3. String: description
4. Amount: amount

CreateSingleChargeForSubscriptionWithInvoice

com.cdrator.billing.charge.action.CreateSingleChargeForSubscriptionWithInvoice

8.7

Creates and saves a Charge for a Subscription on a specific invoice. Adding the charge directly is optional, and if selected will create invoice detail lines directly.Adding description and amount is also optional, and if not specified, the amount and description will be default to the ones specified on the Charge Item fields.

Charge: The created charge is returned.

1. addCharge: If the charge should be added now. Default is false to let the Charge Engine pick it up instead.

1. Subscription: subscription
2. ChargeItem: chargeItem
3. String: description
4. Amount: amount
5. Invoice: invoice

RoundAllInvoicesInBatch

com.cdrator.billing.charge.action.RoundAllInvoicesInBatch

8.7

Rounds all invoices on an invoicebatch, to nearest whole number.

void: null

1. InvoiceBatch: batch
2. ChargeItem: chargeItem

ChargeItemAdvancedReader

com.cdrator.billing.financial.action.ChargeItemAdvancedReader

8.7

Retrieves charge items based on configurable parameters.

Object: Retrieves a unique or list of persistent objects based on the constraints and operators from the properties and parameters.

1. attributeName1: Attribute 1
2. attributeName2: Attribute 2
3. attributeName3: Attribute 3
4. getList: Return a single value (default) or a list of values
5. operator1: Operator 1
6. operator2: Operator 2
7. operator3: Operator 3

1. Object: constraint1
2. Object: constraint2
3. Object: constraint3

ChargeItemReader

com.cdrator.billing.financial.action.ChargeItemReader

8.7

Retrieves a ChargeItem based on configurable parameters.

PersistentObject: Retrieves the a persistent object based on the constraints from the properties and parameters.

1. attributeName1: Attribute 1
2. attributeName2: Attribute 2
3. attributeName3: Attribute 3

1. Object: constraint1
2. Object: constraint2
3. Object: constraint3

FilterInvoiceDetailLinesByBillingGroup

com.cdrator.billing.financial.action.FilterInvoiceDetailLinesByBillingGroup

8.7

This action filters an list of invoice detail lines so only the ones related to the billing group are returned.

List: A list of invoice detail lines related to the billing group.

1. List: invoiceDetailLines
2. BillingGroup: billingGroup

AddChargeToBillingGroup

com.cdrator.billing.financial.billing.action.AddChargeToBillingGroup

8.7

Adds a charge to a billing group.

Charge: The created charge is returned.

1. BillingGroup: billingGroup
2. ChargeItem: chargeItem
3. String: description
4. Number: amount

This action is deprecated and therefore should not be used.

BuildAccountPaymentsForInvoicesOnBatch

com.cdrator.billing.financial.billing.action.BuildAccountPaymentsForInvoicesOnBatch

8.7

Adds a charge to all invoices on a batch if the specified CdrParameter name matches the given CdrParameter string value of the associated billinggroup.

boolean: True is always returned.

1. paymentType: The account payment type that should be used for the payment.

1. InvoiceBatch: batch
2. String: cdrParameterName
3. String: parameterValue

CreateBillingGroupRefundRequest

com.cdrator.billing.financial.billing.action.CreateBillingGroupRefundRequest

8.7

Create a billing group refund request

BillingGroupRefundRequest: The created BillingGroupRefundReqest

1. type: The account payment type that should be used for the payment.

1. BillingGroup: billingGroup
2. boolean: refundTotalBalance
3. float: amount
4. String: comment

DoAccountPayment

com.cdrator.billing.financial.billing.action.DoAccountPayment

8.7

Creates an account payment and authorize payment. If successful authorization the PAYMENT_REFERENCE and PAYMENT_RESULT's are added to the hookpoint result.

AccountPayment: Returns the account payment

1. accountPaymentTypeId: The account payment type of the recharge ticket.
2. skipAuthorizeAccountPayment: If selected the accountpayment will not be authorized by this action.

1. RechargeTicket: rechargeTicket
2. Invoice: invoice
3. BillingGroup: billingGroup
4. String: paymentRequestRef
5. HookpointResult: hookpointResult

GetListOfServicesInStatusFromSubscriptions

com.cdrator.billing.financial.billing.action.GetListOfServicesInStatusFromSubscriptions

8.7

Returns a list of services in certain statuses. This action takes a list of Subscriptions and a list of StatusService as arguments.

List: List of services related to the subscriptions passed as argument which are in one of the statuses also passed as argument.

1. List: subscriptions
2. List: statuses

GetNewInvoice

com.cdrator.billing.financial.billing.action.GetNewInvoice

8.7

This action creates a new invoice for the supplied billing group. The type of invoice must be set as a property.

Invoice: The newly created Invoice

1. invoiceType: The available invoice types

1. BillingGroup: billingGroup

MakeInvoicePaymentOnInvoicesInBatch

com.cdrator.billing.financial.billing.action.MakeInvoicePaymentOnInvoicesInBatch

8.7

Makes a payment on all invoice in a specific invoice batch, with an amount equal to the outstanding amount on the individual invoice.

boolean: True is always returned.

1. payPostPaidInvoices: Should postpaid invoices be marked as paid.
2. payPrePaidInvoices: Should prepaid invoices be marked as paid.

1. InvoiceBatch: batch
2. String: paymentTypeId
3. String: bObjectId
4. String: reference
5. String: source

ManualDebitOrCredit

com.cdrator.billing.financial.billing.action.ManualDebitOrCredit

8.7

This action calls the function addManualDebitOrCredit on the provided set of parameters.

void: No return value

1. BillingGroup: billingGroup
2. TimeCharge: timeCharge
3. ChargeItem: chargeItem
4. String: description
5. boolean: isDebit
6. Amount: amount
7. Currency: amountCurrency
8. Subscription: subscription
9. Invoice: invoice

PayInvoicesOnBatch

com.cdrator.billing.financial.billing.action.PayInvoicesOnBatch

8.7

Adds a charge to a billing group.

boolean: True is always returned.

1. payPostPaidInvoices: Should postpaid invoices be marked as paid.
2. payPrePaidInvoices: Should prepaid invoices be marked as paid.

1. InvoiceBatch: batch
2. String: paymentTypeId
3. String: bObjectId
4. String: reference
5. String: source

SetBillingGroupCreditDays

com.cdrator.billing.financial.billing.action.SetBillingGroupCreditDays

8.7

This action sets the credit days on a billing group.

void: No return value.

1. BillingGroup: billingGroup
2. long: creditDays

PaymentMethodReader

com.cdrator.billing.financial.PaymentMethodReader

8.7

Retrieves a Payment Method entity based on configurable parameters

PersistentObject: Retrieves the a persistent object based on the constraints from the properties and parameters.

1. attributeName1: Attribute 1
2. attributeName2: Attribute 2
3. attributeName3: Attribute 3

1. Object: constraint1
2. Object: constraint2
3. Object: constraint3

PaymentLogReader

com.cdrator.billing.financial.payments.action.PaymentLogReader

8.7

Retrieves a Payment Log based on configurable parameters

PersistentObject: Retrieves the a persistent object based on the constraints from the properties and parameters.

1. attributeName1: Attribute 1
2. attributeName2: Attribute 2
3. attributeName3: Attribute 3

1. Object: constraint1
2. Object: constraint2
3. Object: constraint3

RechargeTicketReader

com.cdrator.billing.financial.payments.action.RechargeTicketReader

8.7

Retrieves a Recharge Ticket based on configurable parameters

PersistentObject: Retrieves the a persistent object based on the constraints from the properties and parameters.

1. attributeName1: Attribute 1
2. attributeName2: Attribute 2
3. attributeName3: Attribute 3

1. Object: constraint1
2. Object: constraint2
3. Object: constraint3

CloseInvoiceWithCurrentDate

com.cdrator.billing.invoice.action.CloseInvoiceWithCurrentDate

8.7

Calls closeWithDueDate on a given invoice with current date.

void: No return value.

1. Invoice: invoice

GetAccountPaymentsForInvoice

com.cdrator.billing.invoice.action.GetAccountPaymentsForInvoice

8.7

Gets a list of account payments related to the invoice.

List: A list of accountPayments.

1. Invoice: invoice

GetOldestUnpaidInvoice

com.cdrator.billing.invoice.action.GetOldestUnpaidInvoice

8.7

Finds and returns the oldest unpaid invoice if there are any

Invoice: The oldest unpaid invoice. If no closed unpaid invoice is found, null is returned

1. BillingGroup: billingGroup

InvoiceAdvancedReader

com.cdrator.billing.invoice.action.InvoiceAdvancedReader

8.7

Retrieves invoices based on configurable parameters.

Object: Retrieves a unique or list of persistent objects based on the constraints and operators from the properties and parameters.

1. attributeName1: Attribute 1
2. attributeName2: Attribute 2
3. attributeName3: Attribute 3
4. getList: Return a single value (default) or a list of values
5. operator1: Operator 1
6. operator2: Operator 2
7. operator3: Operator 3

1. Object: constraint1
2. Object: constraint2
3. Object: constraint3

InvoiceCompareToLastStepId

com.cdrator.billing.invoice.action.InvoiceCompareToLastStepId

8.7

Checks Invoice lastStepId against string with comma-separated list of Id . (IE '50,55,58' may at collector) with true/false as default result for blank value

boolean: true or false

1. Invoice: invoice
2. String: compareString
3. boolean: defaultForBlank

InvoiceReader

com.cdrator.billing.invoice.action.InvoiceReader

8.7

Retrieves an invoice based on configurable parameters.

PersistentObject: Retrieves the a persistent object based on the constraints from the properties and parameters.

1. attributeName1: Attribute 1
2. attributeName2: Attribute 2
3. attributeName3: Attribute 3

1. Object: constraint1
2. Object: constraint2
3. Object: constraint3

InvoiceSetInvoiceScheduleId

com.cdrator.billing.invoice.action.InvoiceSetInvoiceScheduleId

8.7

set Invoice ScheduleId on invoice

void: No return value.

1. Invoice: invoice
2. String: id

PayInvoicesInBatchWithAccountPayments

com.cdrator.billing.invoice.action.PayInvoicesInBatchWithAccountPayments

8.7

Marks all invoice on batch as paid

void: null

1. InvoiceBatch: invoiceBatch
2. String: reference
3. String: transactionNumber
4. AccountPaymentType: accountPaymentType

PublishInvoice

com.cdrator.billing.invoice.action.PublishInvoice

8.7

Publishes a given invoice.

Invoice: The published invoice

1. Invoice: invoice

SetInvoiceDueDate

com.cdrator.billing.invoice.action.SetInvoiceDueDate

8.7

Set the given due date to the invoice.

void: No return value.

1. Invoice: invoice
2. Date: dueDate

SetDueDateIfInvoicedBillingGroupHasRechargeTicket

com.cdrator.billing.invoicebatch.action.SetDueDateIfInvoicedBillingGroupHasRechargeTicket

8.7

Updates invoice due date for invoices where the related billing group has a recharge ticket

void: No return value

1. InvoiceBatch: invoiceBatch
2. Date: dueDate

GetBillingGroupsByUserID

com.cdrator.billing.main.action.GetBillingGroupsByUserID

8.7

This action will return an arraylist of billing groups that a given userID is the owner of.

ArrayList: An array list of billing groups.

1. String: userID

SetBillingGroupCurrencyCode

com.cdrator.billing.main.action.SetBillingGroupCurrencyCode

8.7

This action sets the currency code on the billing group. The billing group is saved.

void: No return value.

1. currencyCode: The currency code which is set on the billing group.

1. BillingGroup: billingGroup

SetSubscriptionTerminationRequestExpectedDate

com.cdrator.billing.main.action.SetSubscriptionTerminationRequestExpectedDate

8.7

This action sets the expected termination date on a SubscriptionTerminationRequest.

SubscriptionTerminationRequest: Returns the updated SubscriptionTerminationRequest object.

1. SubscriptionTerminationRequest: subscriptionTerminationRequest
2. Date: expectedTerminationDate

TerminateSharedServiceIfNoTeleservices

com.cdrator.billing.main.action.TerminateSharedServiceIfNoTeleservices

8.7

This action iterates through all services and subscriptions for the billing group, and if all teleservices are terminated, it attempts to terminate all shared services attached.

Boolean: Returns true if a shared Service was attempted terminated.

1. BillingGroup: billingGroup
2. Date: terminationDate
3. String: hookpointKey
4. String: reason

GetParameterValue

com.cdrator.billing.misc.action.GetParameterValue

8.7

This action retrieves a string representation of a parameter value.

String: Returns the string value of the parameter requested. Or an empty string, if none exists.

1. String: key
2. Brand: brand

AccountPaymentAdvancedReader

com.cdrator.billing.payment.action.AccountPaymentAdvancedReader

8.7

Retrieves an account payment based on configurable parameters.

Object: Retrieves a unique or list of persistent objects based on the constraints and operators from the properties and parameters.

1. attributeName1: Attribute 1
2. attributeName2: Attribute 2
3. attributeName3: Attribute 3
4. getList: Return a single value (default) or a list of values
5. operator1: Operator 1
6. operator2: Operator 2
7. operator3: Operator 3

1. Object: constraint1
2. Object: constraint2
3. Object: constraint3

AccountPaymentReader

com.cdrator.billing.payment.action.AccountPaymentReader

8.7

Retrieves an account payment based on configurable parameters.

PersistentObject: Retrieves the a persistent object based on the constraints from the properties and parameters.

1. attributeName1: Attribute 1
2. attributeName2: Attribute 2
3. attributeName3: Attribute 3

1. Object: constraint1
2. Object: constraint2
3. Object: constraint3

AccountPaymentSetAuthorized

com.cdrator.billing.payment.action.AccountPaymentSetAuthorized

8.7

Calls setAuthorized on a given account payment and saves it.

void: No return value.

1. AccountPayment: accountPayment

AccountPaymentSetCaptureInfo

com.cdrator.billing.payment.action.AccountPaymentSetCaptureInfo

8.7

Set capture info on AccountPayment (For Dynamic setting of CaptureMessage use AcountPaymentSetCaptureMessage)

void: No return value

1. captureMessage: Capture message to be set.
2. useCaptureDate: Should Capture Date be set (to current time.

1. AccountPayment: ap

AccountPaymentSetDoCapture

com.cdrator.billing.payment.action.AccountPaymentSetDoCapture

8.7

Calls setDoCapture on a given account payment and saves it.

void: No return value.

1. AccountPayment: accountPayment

AccountPaymentTypeAdvancedReader

com.cdrator.billing.payment.action.AccountPaymentTypeAdvancedReader

8.7

Retrieves account payment types based on configurable parameters.

Object: Retrieves a unique or list of persistent objects based on the constraints and operators from the properties and parameters.

1. attributeName1: Attribute 1
2. attributeName2: Attribute 2
3. attributeName3: Attribute 3
4. getList: Return a single value (default) or a list of values
5. operator1: Operator 1
6. operator2: Operator 2
7. operator3: Operator 3

1. Object: constraint1
2. Object: constraint2
3. Object: constraint3

AccountPaymentTypeReader

com.cdrator.billing.payment.action.AccountPaymentTypeReader

8.7

Retrieves an account payment based on configurable parameters.

PersistentObject: Retrieves the a persistent object based on the constraints from the properties and parameters.

1. attributeName1: Attribute 1
2. attributeName2: Attribute 2
3. attributeName3: Attribute 3

1. Object: constraint1
2. Object: constraint2
3. Object: constraint3

AcountPaymentSetCaptureMessage

com.cdrator.billing.payment.action.AcountPaymentSetCaptureMessage

8.7

Set capture message on AccountPayment

void: No return value

1. AccountPayment: ap
2. String: captureMessage

DeleteRechargeTicket

com.cdrator.billing.payment.action.DeleteRechargeTicket

8.7

Use the DeleteRechargeTicketUsingRemover action if available. This action deletes a recharge ticket from the system. A history line is created with information about the deleted recharge ticket.

void: Nothing is returned.

1. RechargeTicket: rechargeTicket

GetActiveRechargeTicket

com.cdrator.billing.payment.action.GetActiveRechargeTicket

8.7

This action returns an active recharge ticket for a given billing group.

RechargeTicket: The recharge ticket, if it exists.

1. BillingGroup: billingGroup

GetRechargeTicketForBillingGroup

com.cdrator.billing.payment.action.GetRechargeTicketForBillingGroup

8.7

This action returns a rechargeTicket for a BillingGroup.

RechargeTicket: The recharge ticket, if it exists.

1. BillingGroup: billingGroup

DeviceCanUseOn

com.cdrator.billing.product.action.DeviceCanUseOn

8.7

Calls CanUseOn on a given device with a given service.

boolean: Boolean showing if a given device can be used on a given service.

1. Device: device
2. Service: service

GetDeviceFromParameterValue

com.cdrator.billing.product.action.GetDeviceFromParameterValue

8.7

Locates a device with a given parameter name and value. If no device is found, it throws an ActionParameterException.

Device: The located device.

1. String: name
2. String: value

GetDeviceParameterValue

com.cdrator.billing.product.action.GetDeviceParameterValue

8.7

This action returns the value of a given device parameter or throws a NullValueException if none is found.

String: Value of the given parameter (as a string).

1. Device: device
2. String: name

SetDeviceParameterValue

com.cdrator.billing.product.action.SetDeviceParameterValue

8.7

This action updates a device parameter value if it's found, otherwise it will be created.

boolean: True if the parameter was created, false if the parameter was updated.

1. Device: device
2. String: name
3. String: value

CompleteRatePlanChange

com.cdrator.billing.product.ratePlanChange.action.CompleteRatePlanChange

8.7

This action completes the rateplan change by subscribing to the default and mandatory options.

void: No return value.

1. RatePlanChange: rpc
2. boolean: cache

GetRatePlanAvailableOptions

com.cdrator.billing.rateplan.action.GetRatePlanAvailableOptions

8.7

Gets the list of the rate plan's available options optionally filtered by option key prefix

List: The list of the rate plan's available options optionally filtered by option key prefix

1. optionKeyPrefix: The checked option key prefix

1. RatePlan: ratePlan

GetActiveRatePlanForSubscription

com.cdrator.billing.rating.action.GetActiveRatePlanForSubscription

8.7

Retrieves the currently active rate plan for a subscription.

RatePlan: Returns a rate plan that is currently active for the subscription.

1. Subscription: subscription

GetPlanElement

com.cdrator.billing.rating.action.GetPlanElement

8.7

This action returns a planElement based on a fee code

PlanElements: Return the planElement

1. planElement: The plan elements.

GetPlanElementForRatePlan

com.cdrator.billing.rating.action.GetPlanElementForRatePlan

8.7

This action returns a planElement based on a fee code

PlanElements: Return the planElement

1. planElement: The plan elements.

1. RatePlan: ratePlan

GetPlanElementForRatePlanByDynamicFeeCode

com.cdrator.billing.rating.action.GetPlanElementForRatePlanByDynamicFeeCode

8.7

This action returns a planElement based on a fee code

PlanElements: Return the planElement

1. RatePlan: ratePlan
2. String: planElementCode

GetRatePlansByProduct

com.cdrator.billing.rating.action.GetRatePlansByProduct

8.7

This action retrieves rate plans for a product.

List: Returns a list of rate plans related to this product.

1. Product: product

RatePlanAdvancedReader

com.cdrator.billing.rating.action.RatePlanAdvancedReader

8.7

Retrieves rate plans based on configurable parameters.

Object: Retrieves a unique or list of persistent objects based on the constraints and operators from the properties and parameters.

1. attributeName1: Attribute 1
2. attributeName2: Attribute 2
3. attributeName3: Attribute 3
4. getList: Return a single value (default) or a list of values
5. operator1: Operator 1
6. operator2: Operator 2
7. operator3: Operator 3

1. Object: constraint1
2. Object: constraint2
3. Object: constraint3

RatePlanReader

com.cdrator.billing.rating.action.RatePlanReader

8.7

Retrieves a RatePlan based on configurable parameters.

PersistentObject: Retrieves the a persistent object based on the constraints from the properties and parameters.

1. attributeName1: Attribute 1
2. attributeName2: Attribute 2
3. attributeName3: Attribute 3

1. Object: constraint1
2. Object: constraint2
3. Object: constraint3

BillingRecordBuilder

com.cdrator.billing.rating.simulate.action.BillingRecordBuilder

8.7

Builds a billing record based of a rating code, rating key, volume and duration. The new Billing Record will not be persisted.

BillingRecordSimulated: A new unrated billing record. Not persisted.

1. BNumber: B-Number of the billing record.
2. ratingCode: Rating code to be set on the Billing Record.
3. ratingDuration: Rating duration to be set on the Billing Record.
4. ratingKey: Rating key to be set on the Billing Record.
5. ratingVolumne: Rating volume to be set on the Billing Record.

1. Service: service

CalculateInvoiceDetailLinesTotalChargeSum

com.cdrator.billing.rating.simulate.action.CalculateInvoiceDetailLinesTotalChargeSum

8.7

Calculates the Sum to the total charge for a list of Invoice Detail Lines Wrappers. The action will throw an ActionParameterException if the parameter throwExceptionIfAllLinesIgnored is set to true, and all lines passed in is ignored.

Amount: The sum to the total charges of the Invoice Detail Lines Wrappers

1. ignoreLinesWithChargeItemCategory: Invoice Detail Lines Wrappers with this Charge Item Category Key will not be included in the sum
2. throwExceptionIfAllLinesIgnored: Invoice Detail Lines Wrappers with this Charge Item Category Key will not be included in the sum

1. List: idlList

RatingSimulator

com.cdrator.billing.rating.simulate.action.RatingSimulator

8.7

Simulates the rating of a Billing Record. The Billing Record could be of type BillingRecordSimulated. After rating all changes are rolled back. The result is list of Invoice Detail Lines

ArrayList: ArrayList of the Invoice Detail Lines

1. Service: service
2. BillingRecords: billingRecord

StatusAdvancedReader

com.cdrator.billing.status.action.StatusAdvancedReader

8.7

Retrieves statuses based on configurable parameters.

Object: Retrieves a unique or list of persistent objects based on the constraints and operators from the properties and parameters.

1. attributeName1: Attribute 1
2. attributeName2: Attribute 2
3. attributeName3: Attribute 3
4. getList: Return a single value (default) or a list of values
5. operator1: Operator 1
6. operator2: Operator 2
7. operator3: Operator 3

1. Object: constraint1
2. Object: constraint2
3. Object: constraint3

StatusReader

com.cdrator.billing.status.action.StatusReader

8.7

Retrieves a Status object based on configurable parameters

PersistentObject: Retrieves the a persistent object based on the constraints from the properties and parameters.

1. attributeName1: Attribute 1
2. attributeName2: Attribute 2
3. attributeName3: Attribute 3

1. Object: constraint1
2. Object: constraint2
3. Object: constraint3

AddFee

com.cdrator.billing.subscriptionFees.action.AddFee

8.7

Adds a subscription fee to a subscription for a given plan element preffix and code. By default the start date is not charged.

SubscriptionFees: Returns the added subscription fee.

1. chargeStartDate: Charge the given start date.
2. feeCode: The fee code for the subscription fee.

1. Subscription: subscription
2. Date: startDate

AddFeeFromServiceCode

com.cdrator.billing.subscriptionFees.action.AddFeeFromServiceCode

8.7

Adds a subscription fee to a subscription for a given plan element preffix defined by a service code and a price code./nBy default the start date is not charged.

SubscriptionFees: Returns the added subscription fee.

1. chargeStartDate: Charge the given start date.

1. Subscription: subscription
2. Date: startDate
3. String: serviceCode
4. String: priceCode

AddSubscriptionFee

com.cdrator.billing.subscriptionFees.action.AddSubscriptionFee

8.7

Add a subscription fee to a subscription for a given plan element preffix and code. By default the start date is not charged.

SubscriptionFees: Return the added subscription fee.

1. chargeStartDate: Charge the given start date.
2. planElement: The plan element for the subscription fee.

1. Subscription: subscription
2. Date: startDate

This action is deprecated and therefore should not be used.

ChargeFee

com.cdrator.billing.subscriptionFees.action.ChargeFee

8.7

Adds a subscription fee to a subscription for a given plan element preffix and code, if the property is not set the fee code value from the parameter will be used. By default the start date is not charged. The fee is billed after its creation.

SubscriptionFees: Returns the added subscription fee.

1. chargeStartDate: Charge the given start date.
2. feeCode: The fee code for the subscription fee.

1. Subscription: subscription
2. String: feeCode
3. Date: startDate

CreateSubscriptionFee

com.cdrator.billing.subscriptionFees.action.CreateSubscriptionFee

8.7

Creates a subscription fee to a subscription for a given plan element prefix and code. The subscription fee is not persisted

SubscriptionFees: Returns the added subscription fee.

1. chargeStartDate: Charge the given start date.

1. Subscription: subscription
2. String: feeCode
3. Date: startDate

IsBalanceGreatherThanFeePrice

com.cdrator.billing.subscriptionFees.action.IsBalanceGreatherThanFeePrice

8.7

Check if the billing group balance is equal or greater than the price of the given fee and rate plan.

boolean: True if the billing group balance is sufficient. False otherwise.

1. BillingGroup: billingGroup
2. String: feeCode
3. RatePlan: ratePlan

SetSubscriptionFeesEndDate

com.cdrator.billing.subscriptionFees.action.SetSubscriptionFeesEndDate

8.7

This action sets the subscription fee end date and saves the subscriptionfee.

void: No return value

1. SubscriptionFees: subscriptionFee
2. Date: endDate

SubscriptionFeesAdvancedReader

com.cdrator.billing.subscriptionFees.action.SubscriptionFeesAdvancedReader

8.7

Retrieves subscription fees based on configurable parameters.

Object: Retrieves a unique or list of persistent objects based on the constraints and operators from the properties and parameters.

1. attributeName1: Attribute 1
2. attributeName2: Attribute 2
3. attributeName3: Attribute 3
4. getList: Return a single value (default) or a list of values
5. operator1: Operator 1
6. operator2: Operator 2
7. operator3: Operator 3

1. Object: constraint1
2. Object: constraint2
3. Object: constraint3

SubscriptionFeesReader

com.cdrator.billing.subscriptionFees.action.SubscriptionFeesReader

8.7

Gets a subscription fee.

PersistentObject: Retrieves the a persistent object based on the constraints from the properties and parameters.

1. attributeName1: Attribute 1
2. attributeName2: Attribute 2
3. attributeName3: Attribute 3

1. Object: constraint1
2. Object: constraint2
3. Object: constraint3

CreateTodoTask

com.cdrator.billing.todoTask.action.CreateTodoTask

8.7

This class is deprecated. Use CreateTodoTaskDynamic instead. Old description: Creates a TodoTask based on configurable properties

void: No return values

1. assignedToOperator: The operator the todo task is assigned to
2. category: Task category
3. contactPhoneNumber: Contact phone number
4. description: Task Description
5. reminderTimeInMinutes: Reminder time in minutes
6. subject: Subject
7. typeOfFollowUp: The type of follow up: email,letter,phone call,sms

1. Service: service

This action is deprecated and therefore should not be used.

CreateTodoTaskAdvanced

com.cdrator.billing.todoTask.action.CreateTodoTaskAdvanced

8.7

Creates a TodoTask based on configurable properties. CreationDate, ScheduledEndTime, TimestampAlert are set to current date if passed as null

TodoTask: Return just created todo task.

1. assignedToOperator: The operator the todo task is assigned to
2. category: Task category
3. typeOfFollowUp: The type of follow up: email,letter,phone call,sms

1. Service: service
2. String: subject
3. String: description
4. String: contactPhoneNumber
5. long: reminderTimeInMinutes
6. Date: creationDate
7. Date: scheduledEndTime
8. Date: timestampAlert

CreateTodoTaskDynamic

com.cdrator.billing.todoTask.action.CreateTodoTaskDynamic

8.7

Creates a TodoTask based on configurable properties

TodoTask: Return just created todo task.

1. assignedToOperator: The operator the todo task is assigned to
2. category: Task category
3. typeOfFollowUp: The type of follow up: email,letter,phone call,sms

1. Service: service
2. String: subject
3. String: description
4. String: contactPhoneNumber
5. long: reminderTimeInMinutes

This action is deprecated and therefore should not be used.

BrandAdvancedReader

com.cdrator.brand.action.BrandAdvancedReader

8.7

Retrieves brands based on configurable parameters.

Object: Retrieves a unique or list of persistent objects based on the constraints and operators from the properties and parameters.

1. attributeName1: Attribute 1
2. attributeName2: Attribute 2
3. attributeName3: Attribute 3
4. getList: Return a single value (default) or a list of values
5. operator1: Operator 1
6. operator2: Operator 2
7. operator3: Operator 3

1. Object: constraint1
2. Object: constraint2
3. Object: constraint3

BrandReader

com.cdrator.brand.action.BrandReader

8.7

Retrieves a Brand based on configurable parameters.

PersistentObject: Retrieves the a persistent object based on the constraints from the properties and parameters.

1. attributeName1: Attribute 1
2. attributeName2: Attribute 2
3. attributeName3: Attribute 3

1. Object: constraint1
2. Object: constraint2
3. Object: constraint3

CampaignAdvancedReader

com.cdrator.campaign.action.CampaignAdvancedReader

8.7

Retrieves campaigns based on configurable parameters.

Object: Retrieves a unique or list of persistent objects based on the constraints and operators from the properties and parameters.

1. attributeName1: Attribute 1
2. attributeName2: Attribute 2
3. attributeName3: Attribute 3
4. getList: Return a single value (default) or a list of values
5. operator1: Operator 1
6. operator2: Operator 2
7. operator3: Operator 3

1. Object: constraint1
2. Object: constraint2
3. Object: constraint3

CampaignReader

com.cdrator.campaign.action.CampaignReader

8.7

Retrieves a Campaign definition based on configurable parameters.

PersistentObject: Retrieves the a persistent object based on the constraints from the properties and parameters.

1. attributeName1: Attribute 1
2. attributeName2: Attribute 2
3. attributeName3: Attribute 3

1. Object: constraint1
2. Object: constraint2
3. Object: constraint3

GetBundlesFromCampaign

com.cdrator.campaign.action.GetBundlesFromCampaign

8.7

Returns an list of campaign bundles from a campaign.

ArrayList: a list of campaign bundles

1. Campaign: campaign

GetCampaignForKey

com.cdrator.campaign.action.GetCampaignForKey

8.7

This action returns a campaign for which the campaign key is provided as a property.

Campaign: The campaign associated with the provided campaign key.

1. campaignKey: The campaign key for the campaign.

GetCurrentSubscriptionCampaign

com.cdrator.campaign.action.GetCurrentSubscriptionCampaign

8.7

This action returns the current SubscriptionCampaign for a subscription and campaign.

SubscriptionCampaign: The current SubscriptionCampaign.

1. Subscription: subscription
2. Campaign: campaign

GetNewSubscriptionBundle

com.cdrator.campaign.action.GetNewSubscriptionBundle

8.7

This action creates and returns a new SubscriptionBundle.

SubscriptionBundle: Returns a new SubscriptionBundle

1. Bundle: bundle
2. Subscription: subscription
3. SubscriptionCampaign: subscriptionCampaign

GetSubscriptionCampaignsByCriteria

com.cdrator.campaign.action.GetSubscriptionCampaignsByCriteria

8.7

This action returns the current SubscriptionCampaign for a given subscription and some configurable criterias.

List: A list of SubscriptionCampaign matching given criterias.

1. Subscription: subscription
2. String: criterias

SetListOfSubscriptionCampaignToDateToSpecificDate

com.cdrator.campaign.action.SetListOfSubscriptionCampaignToDateToSpecificDate

8.7

Sets the subscription_campaign's to_date to a specific date retrieved from the context for a list of subscription campaigns

void: No return values

1. List: subscriptionCampaigns
2. Date: date

SetSubBundleVal1FromServiceOption

com.cdrator.campaign.action.SetSubBundleVal1FromServiceOption

8.7

This action updates value1 if an associated serviceOptionParameter with a given key can be found.

boolean: Boolean indicating success of finding and setting the parameter.

1. bundleKey: The Bundle key (set in bundle parameter as BUNDLE_KEY=XYZ) that should be set.
2. parameterKey: The key of the serviceOptionParameter that contains the value that should be set to value1.

1. SubscriptionBundle: bundle
2. Broker: broker

SetSubscriptionCampaignCollectionFromToDate

com.cdrator.campaign.action.SetSubscriptionCampaignCollectionFromToDate

8.7

Sets and/or regulates the FROM_DATE/TO_DATE, on a list of subscription campaigns.

boolean: Returns true if at least one date is set on a subscription campaigns, otherwise returns false.

1. calendarField: The calendar field type.
2. dateColumn: The date that should be changed.
3. quantity: Amount +/- that should be added or subtracted to the date.

1. ArrayList: subscriptionCampaignList
2. Date: newDate

SetSubscriptionCampaignFromDateToNextMonth

com.cdrator.campaign.action.SetSubscriptionCampaignFromDateToNextMonth

8.7

Sets the subscriptionCampaign.fromDate to the first day of next month.

void: No return values

1. SubscriptionCampaign: subscriptionCampaign

SetSubscriptionCampaignFromDateToSpecificDate

com.cdrator.campaign.action.SetSubscriptionCampaignFromDateToSpecificDate

8.7

Sets the subscriptionCampaign.fromDate to a specific date.

void: No return values

1. SubscriptionCampaign: subscriptionCampaign
2. Date: date

SetSubscriptionCampaignInstanceFromToDate

com.cdrator.campaign.action.SetSubscriptionCampaignInstanceFromToDate

8.7

Sets and/or regulates the FROM_DATE/TO_DATE, on a subscription campaign.

boolean: Returns true if the date is set on a subscription campaigns, otherwise returns false.

1. calendarField: The calendar field type.
2. dateColumn: The date that should be changed.
3. quantity: Amount +/- that should be added or subtracted to the date.

1. SubscriptionCampaign: subscriptionCampaign
2. Date: newDate

SetSubscriptionCampaignParameter

com.cdrator.campaign.action.SetSubscriptionCampaignParameter

8.7

An action to set subscriptionCampaign parameters.

void: No return value.

1. parameterName: The name of the Subscription Campaign parameter that should be set.

1. SubscriptionCampaign: subscriptionCampaign
2. String: value

SetSubscriptionCampaignToDateRestOfMonth

com.cdrator.campaign.action.SetSubscriptionCampaignToDateRestOfMonth

8.7

This action sets the toDate on a subscriptionCampaign to the end of the current month.

SubscriptionCampaign: The subscription campaign.

1. SubscriptionCampaign: subscriptionCampaign

SetSubscriptionCampaignToDateToSpecificDate

com.cdrator.campaign.action.SetSubscriptionCampaignToDateToSpecificDate

8.7

Sets the subscription_campaign's to_date to a specific date retrieved from the context

void: No return values

1. SubscriptionCampaign: subscriptionCampaign
2. Date: date

SubCampaignSetParameter

com.cdrator.campaign.action.SubCampaignSetParameter

8.7

This action sets a parameter on a subscriptionCampaign to be equal to the given ServiceOptionParameter value.

boolean: True if the parameter is set, false otherwise.

1. paramName: The name of the Subscription Campaign parameter that should be set.

1. Subscription: sub
2. ServiceOptionParameter: sop

SubCampaignSetParameterFromSOP

com.cdrator.campaign.action.SubCampaignSetParameterFromSOP

8.7

This action updates a subscription campaign parameter from a service option parameter with a given key.

boolean: True if the parameter is set, false otherwise.

1. bundleKey: The Bundle key (set in bundle parameter as BUNDLE_KEY=XYZ that should be set.
2. paramName: The name of the subscription campaign parameter that should be set.
3. parameterKey: The key of the service option parameter that contains the value that should be set to the subscription campaign.

1. SubscriptionBundle: bundle

SubscriptionCampaignAdvancedReader

com.cdrator.campaign.action.SubscriptionCampaignAdvancedReader

8.7

Retrieves subscription campaigns based on configurable parameters.

Object: Retrieves a unique or list of persistent objects based on the constraints and operators from the properties and parameters.

1. attributeName1: Attribute 1
2. attributeName2: Attribute 2
3. attributeName3: Attribute 3
4. getList: Return a single value (default) or a list of values
5. operator1: Operator 1
6. operator2: Operator 2
7. operator3: Operator 3

1. Object: constraint1
2. Object: constraint2
3. Object: constraint3

SubscriptionCampaignByDate

com.cdrator.campaign.action.SubscriptionCampaignByDate

8.7

Returns true if the subscriptioncampaign is found for a given charge date.

boolean: Returns true if the subscriptioncampaign is found for a given charge date.

1. List: subCampaigns
2. Date: chargeDate

SubscriptionCampaignReader

com.cdrator.campaign.action.SubscriptionCampaignReader

8.7

Retrieves a subscription campaign based on configurable parameters

PersistentObject: Retrieves the a persistent object based on the constraints from the properties and parameters.

1. attributeName1: Attribute 1
2. attributeName2: Attribute 2
3. attributeName3: Attribute 3

1. Object: constraint1
2. Object: constraint2
3. Object: constraint3

TerminateCampaignWithFromDate

com.cdrator.campaign.action.TerminateCampaignWithFromDate

8.7

Sets the subscriptionCampaign.toDate to the subscriptionCampaign.fromDate

void: No return values

1. SubscriptionCampaign: subscriptionCampaign

BundleAdvancedReader

com.cdrator.campaign.bundle.action.BundleAdvancedReader

8.7

Retrieves bundles based on configurable parameters.

Object: Retrieves a unique or list of persistent objects based on the constraints and operators from the properties and parameters.

1. attributeName1: Attribute 1
2. attributeName2: Attribute 2
3. attributeName3: Attribute 3
4. getList: Return a single value (default) or a list of values
5. operator1: Operator 1
6. operator2: Operator 2
7. operator3: Operator 3

1. Object: constraint1
2. Object: constraint2
3. Object: constraint3

BundleReader

com.cdrator.campaign.bundle.action.BundleReader

8.7

Retrieves a Bundle definition based on configurable parameters

PersistentObject: Retrieves the a persistent object based on the constraints from the properties and parameters.

1. attributeName1: Attribute 1
2. attributeName2: Attribute 2
3. attributeName3: Attribute 3

1. Object: constraint1
2. Object: constraint2
3. Object: constraint3

GetActiveSubscriptionBundlesDefinedByDate

com.cdrator.campaign.bundle.action.GetActiveSubscriptionBundlesDefinedByDate

8.7

Returns the active (based on provided date) subscription bundles for a given subscription and the given code.It could be that no subscription bundle yet exists for a given acive subscription campaign, because no usage or otherwise has been registered. In that case, the backend logic will create a new subscription bundle and initialize it. The newly created instance will be returned from this action as part of the result list, BUT will not be persisted. If persistence is desired, it will have to be done outside the scope of this action.

ArrayList: The list of subscription bundles.

1. bundleCode: The code of the subscription bundles to return. The 'ALL' option returns subscription bundles for all bundle codes.

1. Subscription: subscription
2. Date: date

GetBundleForCampaignAndBundleKey

com.cdrator.campaign.bundle.action.GetBundleForCampaignAndBundleKey

8.7

This action returns the bundle associated with the supplied campaign and bundleKey.

Bundle: The bundle associated with the supplied campaign and bundleKey.

1. Campaign: campaign
2. String: bundleKey

GetCurrentSubscriptionBundlesNotUsedUpForCode

com.cdrator.campaign.bundle.action.GetCurrentSubscriptionBundlesNotUsedUpForCode

8.7

Returns the subscription bundles for a given subscription and the given code.

ArrayList: The list of subscription bundles.

1. bundleCode: The code of the subscription bundles.
2. getBundlesWithoutCreatingNew: null

1. Subscription: subscription

GetSubscriptionBundleParameter

com.cdrator.campaign.bundle.action.GetSubscriptionBundleParameter

8.7

Finds a bundle parameter from a SubscriptionBundle.

String: The value of the Bundle parameter.

1. optionKey: The parameter that should be read from the Bundle.

1. SubscriptionBundle: subscriptionBundle

GetSubscriptionBundles

com.cdrator.campaign.bundle.action.GetSubscriptionBundles

8.7

Returns the subscription bundles for a given subscription.

ArrayList: The value of the Bundle parameter.

1. status: The status of the subscription bundles.

1. Subscription: subscription

GetSubscriptionBundlesWithCode

com.cdrator.campaign.bundle.action.GetSubscriptionBundlesWithCode

8.7

Returns the subscription bundles for a given subscription and the given code.

ArrayList: The list of subscription bundles.

1. bundleCode: The code of the subscription bundles.
2. status: The status of the subscription bundles.

1. Subscription: subscription

GetSubscriptionBundleType

com.cdrator.campaign.bundle.action.GetSubscriptionBundleType

8.7

Finds the type of a SubscriptionBundle.

String: The code of the SubscriptionBundle.

1. SubscriptionBundle: subscriptionBundle

GetSubscriptionBundleValue

com.cdrator.campaign.bundle.action.GetSubscriptionBundleValue

8.7

Get the defined Value field in the subscription bundle for the specified bundle.

Amount: The value of the Bundle parameter.

1. bundleParameterName: The Parameter name of the bundle to be matched. If blank, all bundles are affected
2. bundleParameterValue: The Parameter value of the bundle to be matched. If blank, all bundles are affected
3. campaignKey: The key of the campaign
4. valueMethodNumber: The bundle value that will be updated.

1. Subscription: subscription

IsSubscriptionBundleUsedUp

com.cdrator.campaign.bundle.action.IsSubscriptionBundleUsedUp

8.7

Determines if a given subscription bundle is used up by comparing the maximum value with the current value.

boolean: True if the subscription bundle is completely used up, false otherwise.

1. SubscriptionBundle: subscriptionBundle

ProrateActivationSubscriptionCampaignBundles

com.cdrator.campaign.bundle.action.ProrateActivationSubscriptionCampaignBundles

8.7

Create and prorate the bundles of the given subscription campaign for a certain start date.

SubscriptionCampaign: The subscription campaign with the updated bundles

1. roundPrecission: The precission used when rounding the bundles.

1. SubscriptionCampaign: subscriptionCampaign
2. Date: fromDate

SetSubscriptionBundleValue

com.cdrator.campaign.bundle.action.SetSubscriptionBundleValue

8.7

Set the defined Value field in the give subscription bundle.

SubscriptionBundle: The value of the updated Subscription Bundle.

1. value1: Set value 1
2. value2: Set value 2
3. value3: Set value 3
4. value4: Set value 4

1. int: value
2. SubscriptionBundle: subscriptionBundle

SetSubscriptionBundleValueFromServiceOptionParameter

com.cdrator.campaign.bundle.action.SetSubscriptionBundleValueFromServiceOptionParameter

8.7

Set the defined Value field in the subscription bundle for the specified service option parameter.

void: The value of the Bundle parameter.

1. valueMethodNumber: The bundle value that will be updated.

1. ServiceOptionParameter: serviceOptionParameter
2. SubscriptionBundle: subscriptionBundle

SetSubscriptionBundleValues

com.cdrator.campaign.bundle.action.SetSubscriptionBundleValues

8.7

Set the defined Value field in the subscription bundle for the specified bundles.

void: The value of the Bundle parameter.

1. bundleParameterName: The Parameter name of the bundle to be matched. If blank, all bundles are affected
2. bundleParameterValue: The Parameter value of the bundle to be matched. If blank, all bundles are affected
3. campaignKey: The key of the campaign
4. value1: Set value 1
5. value2: Set value 2
6. value3: Set value 3
7. value4: Set value 4

1. String: value
2. Subscription: subscription

SubscriptionBundleAdvancedReader

com.cdrator.campaign.bundle.action.SubscriptionBundleAdvancedReader

8.7

Retrieves subscription bundles based on configurable parameters.

Object: Retrieves a unique or list of persistent objects based on the constraints and operators from the properties and parameters.

1. attributeName1: Attribute 1
2. attributeName2: Attribute 2
3. attributeName3: Attribute 3
4. getList: Return a single value (default) or a list of values
5. operator1: Operator 1
6. operator2: Operator 2
7. operator3: Operator 3

1. Object: constraint1
2. Object: constraint2
3. Object: constraint3

SubscriptionBundleReader

com.cdrator.campaign.bundle.action.SubscriptionBundleReader

8.7

Retrieves a Subscription Bundle based on configurable parameters.

PersistentObject: Retrieves the a persistent object based on the constraints from the properties and parameters.

1. attributeName1: Attribute 1
2. attributeName2: Attribute 2
3. attributeName3: Attribute 3

1. Object: constraint1
2. Object: constraint2
3. Object: constraint3

DocArchiveAdvancedReader

com.cdrator.correspondence.archive.action.DocArchiveAdvancedReader

8.7

Retrieves document archives based on configurable parameters.

Object: Retrieves a unique or list of persistent objects based on the constraints and operators from the properties and parameters.

1. attributeName1: Attribute 1
2. attributeName2: Attribute 2
3. attributeName3: Attribute 3
4. getList: Return a single value (default) or a list of values
5. operator1: Operator 1
6. operator2: Operator 2
7. operator3: Operator 3

1. Object: constraint1
2. Object: constraint2
3. Object: constraint3

DocArchiveReader

com.cdrator.correspondence.archive.action.DocArchiveReader