com.highdeal.pnr.hci (SAP CC 2020 Java APIs (Core Library))

Interface Summary
Interface	Description
BatchChargeResult.BatchChargeResultHandler
ContextualNode	FOR INTERNAL USE ONLY - This `Java interface` allows to chain price plan tree nodes and recursively retrieve the context description.
ForbiddenChargeListener
ICatalogObject	This `Java interface` defines an object which is part of a `catalog` in master data stored in SAP CC.
IChargingResultHolderException	This `Java interface` defines a method to retrieve a `charging result object` in an exception sent by the SAP CC system; consider the `known classes` that implement this interface.
ISessionOperationItemResult	This interface defines the result of a session-based charging operation item.
ISessionOperationResult	This `Java interface` defines the result of a `session-based charging operation`.
PnRObjectSetList.ISortRenderer<T>	This `Java interface` represents methods that manage the PnR object rendering during PnR object sorting.
RateComponentContainer
RatingContextDescription	FOR INTERNAL USE ONLY - This `Java interface` allows to put/get properties from a rating context.
RatingContextDescription.IPropertyFilter	Allows to filter `PropertyDescriptionModel`
SharedObjectsRetriever	FOR INTERNAL USE ONLY - It allows rate components to retrieve shared objects (pricing macros, translation tables, etc.).
StatelessPostRateResult	Object which is returned to your client application from the stateless postrating operation.
StatelessPreRateResult	Object which is returned to the client application from the stateless pre-rate.
SubscriberAccountVisitor

Class Summary
Class	Description
AccessibleChargeModel	This data model is used to facilitate the creation of `accesses` and defines an accessible charge as a `master charge activation` that relates to a price plan that includes at least a usage rate.
AccessModel	This `Java class` represents an access in master data that grants a timed license to an end customer of a service provider to access and use its digital services; In return for this service usage, the access identifies a charge that must be computed and debited for this service consumption.
AccessSearchFilterModel	This `Java class` represents a specialized `search filter` that allows you to retrieve any `access` in the customer master data of a service provider; You specify some `attribute descriptions` or predefined specific formula to define the search criteria.
AccountEventRefillModel	This class represents a refill which is triggered by an event associated to an account.
AccountOperation	This class represents an account operation generated by the SAP CC system during the charging process; Account operations are available in the `charging results`.
AccountOperation.AccountReference	This class represents a reference to an account impacted by a charging operation.
AccountOperation.AmountAssignment	This class represents the assignment of part of the amount of an `account operation` to an account.
AcquisitionParameters	This `Java class` represents the data for the batch acquisition operation of a `chargeable item` or a collection of chargeable items (see the offline charging services and the `acquire(..) methods`) in the charging client.
AcquisitionResult	This `Java class` represents the operation result replied by the connected SAP CC system in response to a batch acquisition operation request of a `chargeable item (CI)` or a collection of chargeable items.
AdditionalInfo	This `Java class` represents an additional information (name, type, value) in the object managed by SAP Convergent Charging; You use this typical object to customize information in your objects.
AdditionalInfoModel	This `Java class` represents an additional information that you can marshal; You use this typical object to customize information in your data.
AmountAlertModel	This class represents an alert which must be `notified by the SAP CC system` when the balance reaches a certain amount.
BasicFieldType
BatchChargeResult	This `Java class` represents the result of the batch charging operation sent to the connected SAP CC system; It includes a replied `set of purchase orders` and `batchChargeFault`
BatchRatingGroupModel	This `Java class` represents a batch rating group configured in the SAP CC.
ChargeableItem	This `Java class` represents a chargeable item that is sent by your client applications or systems (mediation) and to be charged by the connected SAP CC Core Server system; This chargeable item represents data related to the usage (consumption) of a customer service.
ChargeableItemDescriptionModel	This `Java class` represents a chargeable item class the scheme of incoming `chargeable items` that is added to a Chargeable Item Package.
ChargeableItemInfo	This object contains information about the chargeable item associated to a charging result.
ChargeActivationModel	This `Java class` represents a charge activation in a `subscription` (customer master data) owned by a service provider; This data relates to the activation of charges in the `subscribed offer`.
ChargeActivationModificationModel	This class represents a charge activation modification model by using `attributeModificationModel` to describe each modification.
ChargeActivationSearchFilterModel	This class represents the charge activation filter.
ChargeComponentModel	This `Java class` represents a charge component (reusable charge) in a `pricing catalog` of a service provider.
ChargeConditionModel	A `ChargeConditionModel` represents the information to build a new charge condition. Warning
ChargeDependencyModel	This class represents a dependency between two charges.
ChargeDependencySetModel	A charge dependencies set model represents a set of cohesive charge dependencies.
ChargedItemClass<T extends com.highdeal.util.map.PropertyDescription<ChargedItemFieldType>>
ChargedItemClassField
ChargedItemClassFieldModel	This class improves the `ChargedItemClassField` adding XML marshalling.
ChargedItemClassModel	This class improves the `ChargedItemClass` adding XML marshalling.
ChargedItemFieldType
ChargedItemMapping<T extends ChargedItemMappingEntry>	This class represents a charged item mapping which maps fixed values or names of charging context properties to the fields of a `charged item class`.
ChargedItemMappingEntry
ChargedItemMappingEntryFactory
ChargedItemMappingEntryModel	This class improves the `ChargedItemMappingEntry` adding XML marshalling.
ChargedItemMappingFactory
ChargedItemMappingModel	This class represents a charged item mapping which corresponds to the mapping between the chargedItemClass field and a fixed value or a rating context property.
ChargeExecutionContext	This `Java class` defines the conditions under which a charge operation is executed.
ChargeModel	This class is the root class for the different charging classes.
ChargeParameters	This `Java class` represents a list of chargeable items sent in a batch charging operation request; See the offline charging services in `com.highdeal.cnd.message`.
ChargeSnapshotHolderModel	This class represents a `charge activation` inside a `subscription snapshot holder`, and contains the list of included `counters`.
ChargingContractInfo	This object contains information about the charging contract associated to a charging result.
ChargingMappingModel	A `ChargingMappingModel` represents a charging mapping.
ChargingOutputContextDomain	This `Java class` represents a domain of a `ChargeExecutionContext`; You use it to dynamically configure the output data generated when process a charging operation request.
ChargingPlanDictionaryModel	This class represents the dictionary for all the charging plans of the charge component.
ChargingPlanModel	This class represents a charging plan.
ChargingPlanValidator
ChargingPlanValidator.ChargingPlanContext
ChargingProcessInfo	This `Java class` contains information about the Charging process in the SAP CC system.
ChargingResult	This `Java class` represents a charging result that contains information about the result of a charging operation.
ChargingResultContextDomain	This `class` represents a domain of a `ChargeExecutionContext`; You use it to configure the content of the operation result of the charging operation.
ChargingResultOnErrorContextDomain	This class represents a domain of a `ChargeExecutionContext`.
CheckLimitResult	The operation result that is returned by the SAP CC system in response to a check limit operation request. Several operations are provided in the `com.highdeal.cnd.message` `Java package` that you can implement in your client application.
CleanupResult	This class represents an operation result that is returned by the SAP CC system in response to a cleanup operation request when you have implemented the `com.highdeal.cnd.message` `Java package` in you client application.
ClearPrepaidAccountOp	This operation allows to clear a prepaid account in a `subscriber account`; It sets the balance amount of the prepaid account to 0.
ClearPrepaidAccountResult	This class represents the result of the `Clear Prepaid Account operation`.
CommonFieldType
ComponentProperty	This `Java class` is a Helper class to marshal and unmarshal all the rating components.
CounterDescriptionModel	This class represents a counter description.
CounterModel	This class represents a counter in a business relationship.
CounterSnapshotModel	This class represents a daily counter snapshot; Inside the snapshot, the `counters` are organized in a structure similar to the associated `subscription` (root subscription, sub-subscription(s), `charge activation(s)`).
CreateAccessOp	This operation allows you to create a `new access` in customer master data.
CreateAccessResult	A create access result gives the access that has been created.
CreateBatchRatingGroupOp	This operation allows you to create a new `batch rating group`; It fails if a group has already been defined with the same identifier or code.
CreateBatchRatingGroupResult	This result is sent back when the associated `batch rating group` creation was successful.
CreateChargeComponentOp	This operation allows you to create a new charge component.
CreateChargeComponentResult	A create charge component result gives the reference and the code of the charge component that has been created.
CreateChargedItemClassOp	This operation allows to create a `charged item class`.
CreateChargedItemClassResult	A create charged item class result gives the code and the reference of the charged item class that has been created.
CreateExportableItemMappingOp	This operation allows to create an exportable item mapping.
CreateExportableItemMappingResult	A create exportable item mapping result gives the externalSystemCode/citcCode and the reference of the exportable item mapping that has been created.
CreateOfferOp	This operation allows you to create a `new offer` in customer master data of a service provider.
CreateOfferResult	A create offer result gives the code and the reference of the offer that has been created.
CreatePricingMacroOp	This operation allows to create a `new pricing macro` in the pricing catalog (in master data) of the service provider.
CreatePricingMacroResult	A create pricing macro result gives the code and the reference of the pricing macro that has been created.
CreateProductOp	This operation class represents the creation of a product.
CreateProductResult	A create product result gives the code and the reference of the product that has been created.
CreateSubscriberAccountOp	This operation allows you to create a `subscriber account` in customer master data to represent an end customer in the SAP CC system; Relevant `subscriptions` and provider contracts (`charging contracts`) can be created and assigned to this subscriber account.
CreateSubscriberAccountResult	This class represents the result of the `Create Subscriber Account operation`.
CreateSubscriptionOp	This operation allows you to create a new `subscription`.
CreateSubscriptionResult	This class represents the result of the `Create Subscription operation`; It contains the reference and the code of the `subscription` that has been created by the distant SAP CC system.
CreateTierTableOp	This operation class represents the creation of a tier table.
CreateTierTableResult	The create tier table result gives the code and the reference of the created tier table.
CreateTranslationTableOp	This operation class represents the creation of a translation table.
CreateTranslationTableResult	The create translation table result gives the code and the reference of the created translation table.
CreditLimitBalanceModel	This `Java class` represents a credit limit balance defined in a `subscriber account` stored in customer master data owned by a service provider; A credit limit balance is a monetary counter associated to a currency and intended to limit the use of a marketable service for a time period.
CurrenciesModel	This class represents the currencies defined in SAP CC.
CurrencyModel	This class represents a currency defined in SAP CC, made up with the following attributes:.
DefaultChargeActionModel	This class represents the action of charging on the default one of the mapping following a charging mode.
DefaultChargeModel	This class represents a default charge of a charging plan.
DefaultHCIException.ExceptionReason	This class represents the reason of the exception; The reason has a code or a pretty name, a comprehensive message, and a list of arguments.
DeleteAccessBulkOp	This operation allows you to request a bulk deletion of `accesses` thanks to a filter selecting entities to be deleted.
DeleteAccessBulkResult	This class represents the result of the `Delete Access Bulk operation`; It contains the number of `deleted accesses`.
DeleteAccessOp	This operation allows to delete an `access` managed by the connected SAP CC Core Server system.
DeleteAccessResult	The delete access result returns the userServiceId and the serviceID of the deleted access.
DeleteBatchRatingGroupOp	This operation must be used for the deletion of an existing `batch rating group`.
DeleteBatchRatingGroupResult	This result is sent back when associated `batch rating group` deletion was successful.
DeleteChargeComponentOp	This operation allows to the delete of a `charge component` (reusable charge) in master data.
DeleteChargeComponentResult	The delete charge component result returns the code of the deleted charge component.
DeleteChargedItemClassOp	This operation class represents the deletion of a charged item class.
DeleteChargedItemClassResult	The delete charged item class result returns the reference and the code of the deleted charged item class.
DeleteExportableItemMappingOp	This operation allows you to delete some exportable item mapping.
DeleteExportableItemMappingResult	The delete exportable item mapping result returns the reference and the externalSystemCode/citcCode of the deleted exportable item mapping.
DeleteOfferOp	This operation class represents the deletion of an offer.
DeleteOfferResult	The delete offer result returns the code of the deleted offer.
DeletePricingMacroOp	This operation class represents the deletion of a pricing macro.
DeletePricingMacroResult	The delete pricing macro result returns the code of the deleted pricing macro.
DeleteProductOp	This operation class represents the deletion of a product.
DeleteProductResult	The delete product result returns the reference and the code of the deleted product.
DeleteSubscriberAccountOp	Deletes a persistent subscriber account.
DeleteSubscriberAccountResult	This class represents the result of the `Delete Subscriber Account operation`.
DeleteSubscriptionBulkOp	This operation allows to do a bulk deletion of subscriptions thanks to a filter selecting entities to be deleted.
DeleteSubscriptionBulkResult	The delete subscription bulk result returns the number of deleted subscriptions.
DeleteSubscriptionOp	This operation allows to delete a `subscription` in the customer master data of the service provider.
DeleteSubscriptionResult	The delete subscription result returns the code of the deleted subscription.
DeleteTierTableOp	This operation class represents the deletion of a tier table.
DeleteTierTableResult	The delete tier table result returns the code of the deleted tier table.
DeleteTranslationTableOp	This operation allows to delete a `translation table` in the pricing catalog (master data) of a service provider.
DeleteTranslationTableResult	The delete translation table result returns the code of the deleted translation table.
DetailTemplateModel	This class represents a detail template.
DurationModel	This class represents the model of the duration.
ExpirationAlertModel	This class represents an alert which must be `notified by the SAP CC system` before or after a reference date when the state of a `prepaid account` has changed.
ExportableItemMapping<T extends AdditionalInfo,T2 extends ExportableItemMappingField<T>>
ExportableItemMappingField<T extends AdditionalInfo>	This class represents a field in an `ExportableItemMapping`.
ExportableItemMappingFieldModel	This class improves the `ExportableItemMappingField` adding XML marshalling.
ExportableItemMappingModel	This class improves the `ExportableItemMapping` adding XML marshalling.
ExportCurrenciesOp	This operation allows to export the currencies from SAP CC.
ExportCurrenciesResult	This class represents the result of the `Export Currencies operation`.
ExportOp	This operation allows to export a pnr object with all the first class objects it contains.
ExportResult	This class represents the result of the `Export operation`.
ExportSubscriberDataOp	This operation enables to export consistently a `subscriber account` or a `subscription` from its identifier.
ExportSubscriberDataResult	This class represents the result of the `Export Subscriber Data operation`.
ExternalAccountModel	This `Java class` represents an external account defined in a `subscriber account` stored in customer master data owned by a service provider; An external account is a reference to an account that is managed by a third-party accounting system in a postpaid environment.
ExternalChargeActionModel	This class represents the action of charging on an external charging reference.
GetCurrentReratingSessionStatusOp	This operation gives the possibility to retrieve the status of the current rerating session.
GetCurrentReratingSessionStatusResult	This class gives the possibility to retrieve the result of a `Get Current Rerating Session Status operation`; If no rerating session is in progress, the result of the last rerating session is returned.
GetSubAccountSubscriptionCodesOp	This operation allows to retrieve a list of subscription codes for a given subscriber account.
GetSubAccountSubscriptionCodesResult	This class represents the result of the `Get SubAccount Subscription Code operation`.
ImportCurrenciesOp	This operation gives the possibility to import currencies to SAP CC.
ImportCurrenciesResult	This class represents the result of the `Import Currencies operation`.
ImportOp	This operation allows to import a `pnrObjectSet`.
ImportResult	This class represents the result of the `Import operation`.
ImportSubscriberDataOp	This operation enables to import a `subscriber data` that includes master data for an end customer of a service provider.
ImportSubscriberDataResult	This class represents the result of the `Import Subscriber Data operation`.
InAttributeModel	This class represents an input attribute of a translation table and contains a name and a description.
InMacroComponentModel	This class represents a rate component which runs a pricing macro as an in-component.
InMacroPropertyModel	This class represents an input property of a macro and contains a name, a description and the required type of the property.
InternalChargeActionModel	This class represents the action of charging on an internal charging reference following a charging mode.
InvalidSubscriberAccountException.InvalidSubscriberAccountReason
InvalidSubscriberAccountException.ObjectType
ISO4217CurrenciesModel	This class represents the ISO 4217 currencies handled by the system.
ISO4217CurrencyModel	This class represents an ISO 4217 currency defined in SAP CC, made up with the following attributes: - code: The ISO 4217 currency unique code.
MacroComponentModel	This abstract class represents a rate component that runs a pricing macro.
MacroComponentValidator	`validator` for `macro component`.
ModifyAccessOp	This operation allows to modify an existing access.
ModifyAccessResult	A modify access result gives the access that has been modified.
ModifyBatchRatingGroupOp	This operation must be used for the modification of an existing `batch rating group`.
ModifyBatchRatingGroupResult	This result is sent back when associated `batch rating group` modification was successful.
ModifyChargeComponentOp	This operation allows to modify an existing charge component.
ModifyChargeComponentResult	A modify charge component result gives the reference of the charge component that has been modified.
ModifyChargedItemClassOp	This operation class represents the modification of a charged item class.
ModifyChargedItemClassResult	This class represents the result of the `Modify Charged Item Class` operation.
ModifyExportableItemMappingOp	This operation class represents the modification of an exportable item mapping.
ModifyExportableItemMappingResult	This class represents the result of the `Modify Exportable Item Mapping operation`.
ModifyOfferOp	This operation allows to modify an existing offer.
ModifyOfferResult	This class represents the result of the `Modify Offer` operation.
ModifyPricingMacroOp	This operation class represents the modification of a pricing macro.
ModifyPricingMacroResult	This class represents the result of the `Modify Pricing Macro operation`.
ModifyProductOp	This operation class represents the modification of a product.
ModifyProductResult	This class represents the result of the `Modify Product operation`.
ModifySubscriberAccountOp	This operation allows to modify a `subscriber account` in the customer master data managed by the connected SAP CC system.
ModifySubscriberAccountResult	This class represents the result of the `Modify Subscriber Account operation`.
ModifySubscriptionBulkOp	This operation allows to do a bulk modification on subscriptions thanks to a filter selecting entities to be modified, and a modification model containing modifications to be applied on selected entities.
ModifySubscriptionBulkResult	The modify subscription bulk result returns the number of subscriptions answering the filter of research or the number of charge activations answering the filter of research.
ModifySubscriptionOp	This operation allows to modify an existing subscription by providing a complete changed `subscription master data` to the SAP CC system.
ModifySubscriptionResult	This class represents the result of the `Modify Subscription operation`.
ModifyTierTableOp	This operation class represents the modification of a tier table.
ModifyTierTableResult	This class represents the result of the `Modify Tier Table` operation.
ModifyTranslationTableOp	This operation class represents the modification of a translation table.
ModifyTranslationTableResult	This class represents the result of the `Modify Translation Table` operation.
OfferConditionContextModel	A `OfferConditionContextModel` represents a offer condition context.
OfferConditionModel	This class represents the information to subscribe and use an offer inside a packaged offer.
OfferContextModel	A `OfferContextModel` represents a offer context.
OfferModel	This `Java class` represents an offer in master data of a service provider.
OneShotChargeModel	This class represents a one-shot charge of a charging plan.
OneShotRateModel	This class represents a one shot rate that applies on a particular internal event, such as subscription (for setup fees) or cancellation.
OperationExecutionContext	The `Java class` is the context of the execution of an operation, represented as a `list of properties`.
OutAttributeModel	This class represents an output attribute in a translation table and contains a name, a description, a type and a default value.
OutMacroPropertyModel	This class represents an output property of a pricing macro and contains a name, a description, a type and a default value.
OutPropertyUpdateComponentModel	This class represents a rate component that updates a Macro ouput property.
ParameterAdditionalInfoHelper
ParameterModel	This class represents the description of a parameter.
ParameterSetModel	A parameters set model represents a set of cohesive parameters.
PnRObjectSet	This `Java class` represents a PnR object set; A PnR object set represents the transitive closure of a PnR object.
PnRObjectSetList<T>	This `Java class`
PnRXMLMapping	Defines the mapping between XML tags and marshallable classes.
PostRateResult	The result of a postrate operation contains a total amount which is the aggregation of all the master usage transaction amounts.
PreMacroComponentModel	This class represents a rate component which runs a pricing macro as a pre-component.
PrepaidAccountModel	This `Java class` represents a prepaid account defined in a `subscriber account` stored in customer master data owned by a service provider; A prepaid account is a balance defined by a minimal value (empty limit).
PrepaidTransactionFieldMappingModel	This class represents how a detail of a prepaid transaction can be mapped to a constant, or to a property of the rating context.
PrepaidTransactionMappingModel	This class represents a prepaid transaction mapping, that is how properties from the rating context, or constant, can be mapped to details of a prepaid transaction.
PreRateResult	The result of a `PreRateOp` operation.
PreTableComponentModel	This class represents a rate component which executes a translation table.
PreTierTableComponentModel	This class represents a rate component which executes a tier table.
PricePlanModel	This class represents a price plan.
PricingMacroModel	This class represents a pricing macro. The currency used in a pricing macro always corresponds to the currency used by the calling charge component.
ProductModel	This `Java class` represents a chargeable item package (aka product) - that corresponds to something that can be charged.
Property	This `Java class` represents a custom property (string, number, or date) in a `chargeable item`.
PropertyDescriptionModel	This class represents the description of a property as seen by a client application.
PropertyEntryModel	This class represents a property entry.
PropertyIntroducerValidator	This class is used to validate the configuration of the `property introducer rate component`.
PropertyList	List of `Property`, this class provides way to manage Property by their name, name and type.
ProrataModel	This class represents a prorata.
PurchaseOrder	This class contains the transactional data which is returned to your Java-based client application by the connected SAP CC system.
QualifiedChargeableItemDescription	A qualified chargeable item description is a chargeable item description and a product code.
RateComponentModel	Abstract representation of a rate component.
RateModel	This class is the root class for the different rates classes.
RatingContextDescriptionProvider	FOR INTERNAL USE ONLY - This class implements the rating context description interface.
RatingContextDescriptionProvider.ParameterFilter
RecurringChargeModel	This class represents a recurring charge of a charging plan.
RecurringDateModel	This class implements recurring rate.
RecurringRateModel	This `Java class` represents a recurring rate.
ReferenceStateDate	This class represents an enumeration of possible state for expiration alerts.
RefillPrepaidAccountOp	Deprecated
RefillPrepaidAccountResult	This class represents the result of the `operation`.
RerateBulkOp	This operation allows to trigger the rerating process; by default you use this in the SAP CC Core Tool user interface and you do not need to implement this operation in your client application.
RerateBulkResult	This class represents the result of the `Rerate Bulk operation`.
ResetCreditLimitBalanceOp	This operation allows reseting the credit limit balance.
ResetCreditLimitBalanceResult	This class represents the result of the `Reset Credit Limit Balance operation`.
SearchAccessFromSubscriptionOp	This operation allows to retrieve accesses which link a subscription or a charge activation.
SearchAccessFromSubscriptionResult	This class represents the result of the `Search Access From Subscription` operation.
SearchAccessOp	This operation allows retrieving any access by using a `AccessSearchFilterModel` to build search criterias.
SearchAccessResult	This class represents the result of the `Search Access operation`.
SearchAllBatchRatingGroupsOp	This operation must be used for retrieving all the `batch rating group` that are defined.
SearchAllBatchRatingGroupsResult	This class represents the result of the `Search All Batch Rating Groups` operation.
SearchChargeComponentByPricingMacroOp	This operation allows to retrieve charge components using a given pricing macro.
SearchChargeComponentByPricingMacroResult	This class represents the result of the `Search Charge Component by Pricing Macro` operation.
SearchChargeComponentByTierTableOp	This operation allows to retrieve charge components using a given tier table.
SearchChargeComponentByTierTableResult	This class represents the result of the `Search Charge Component By Tier Table` operation.
SearchChargeComponentByTranslationTableOp	This operation allows to retrieve charge components using a given translation table.
SearchChargeComponentByTranslationTableResult	This class represents the result of the `Search Charge Component by Translation Table` operation.
SearchChargeComponentOp	This operation allows to retrieve charge components.The research is doing according to attributes code and-or owner.
SearchChargeComponentResult	This class represents the result of the `Search Charge Component operation`.
SearchChargedItemClassOp	This operation class searches a charged item class given its code or its owner but no combination and returns a charged item classes list.
SearchChargedItemClassResult	This class represents the result of the `Search Charged Item Class operation`.
SearchCodeOp	This operation allows searchinf for an object by specifying its type and optionally its owner and return an object code list.
SearchCodeResult	This class represents the result of the `Search Code operation`.
SearchCodeResult.ObjectCode
SearchExportableItemMappingOp	This operation allows searching for an exportable item mapping given its externalSystemCode and/or charged item class externalSystemCode and returns an exportable item mapping list.
SearchExportableItemMappingResult	This class represents the result of the `SearchExportableItemMappingOp` operation.
SearchExportableItemTemplateNamesOp	This operation class searches empty exportable item mapping names (which we name exportable item template) thank to the Exportable Item Framework (EIF).
SearchExportableItemTemplateNamesResult	This class represents the result of the `SearchExportableItemTemplateNamesOp` operation.
SearchExportableItemTemplateOp	This operation allows searching for empty exportable items mapping (which we name exportable item template) thank to the Exportable Item Framework (EIF).
SearchExportableItemTemplateResult	This class represents the result of the `SearchExportableItemTemplateOp` operation.
SearchOfferByChargeComponentOp	This operation allows to retrieve offers using a given charge component.
SearchOfferByChargeComponentResult	This class represents the result of the `Search Offer by Charge Component` operation.
SearchOfferOp	This operation allows you to retrieve `offers`.
SearchOfferResult	This class represents the result of the `Search Offer operation`.
SearchPricingMacroByPricingMacroOp	This operation allows to retrieve pricing macros using a given pricing macro.
SearchPricingMacroByPricingMacroResult	This class represents the result of the `Search Pricing Macro by Pricing Macro` operation.
SearchPricingMacroByTierTableOp	This operation allows to retrieve pricing macros using a given tier table.
SearchPricingMacroByTierTableResult	This class represents the result of the `Search Pricing Macro by Tier Table` operation.
SearchPricingMacroByTranslationTableOp	This operation allows to retrieve pricing macros using a given translation table.
SearchPricingMacroByTranslationTableResult	This class represents the result of the `Search Pricing Macro by Translation Table` operation.
SearchPricingMacroOp	This operation class allows to search a pricing macro from its code or owner and returns a pricing macro list.
SearchPricingMacroResult	This class represents the result of the `Search Pricing Macro` operation.
SearchProductOp	This operation class searches a product given its code or its vendor but no combination and returns a products list.
SearchProductResult	This class represents the result of the `Search Product` operation.
SearchSubscriberAccountOp	This operation allows retrieving one or more subscriber accounts according to criteria of the specified search filter.
SearchSubscriberAccountResult	This class represents the result of the `Search Subscriber Account` operation.
SearchSubscriptionFromAccessOp	This operation allows retrieving any subscription from an access selection by using a `AccessSearchFilterModel` to build search criterias.
SearchSubscriptionFromAccessResult	This class represents the result of the `Search Subscription From Access` operation.
SearchSubscriptionOp	This operation allows to retrieve subscriptions.
SearchSubscriptionResult	This class represents the result of the `Search Subscription` operation.
SearchTierTableOp	This operation allows to retrieve any tier table by using a `tierTableSearchFilter` to build search criterias.
SearchTierTableResult	This class represents the result of the `Search Tier Table operation`; See `SearchResult` for more information on type.
SearchTranslationRowsOp	This operation allows to retrieve translation table rows from a charge condition in a given offer, at a given date.
SearchTranslationRowsResult	This class represents the result of the `Search Translation Rows operation`.
SearchTranslationTableOp	This operation allows to retrieve any translation table by using a `translationTableSearchFilter` to build search criterias.
SearchTranslationTableResult	This class represents the result of the `Search Translation Table operation`.
SenderContextDomain	This class represents a domain of a `ChargeExecutionContext`.
StartRateResult	The result of a `StartRateOp` operation.
StartSubscriptionReratingResult	This class represents the result of the `Start Rerating operation`.
StatelessContextSerializer	This class provides methods for the serialization and unserialization of the `StatelessRatingContext` and `StatelessPreRatingContext`.
StatelessCounterEffect	This class represents a effect on a counter after a rate stateless.
StatelessPreRatingContext	This class represents the context to be used for stateless pre-rating.
StatelessRateResult	Object which is returned to the client application from the stateless rate.
StatelessRatingContext	This `Java class` represents the stateless rating context that must be speficied when your client application triggers a `rating operation request` (see the online charging services) in the connected SAP CC system.
StatelessRatingEvent	This `Java class` represents a stateless rating event, you specify this information in the `rating operation requests`.
StopRateResult	The result of a `StopRateOp` operation.
StopReratingSessionOp	This operation stops a given rerating session.
StopReratingSessionResult	This class represents the result of a `StopReratingSessionOp` operation.
SubscriberAccountModel	This `Java class` specifies a subscriber account, a master data that represents an end customer (`subscriber`) who want to use a digital service from a service provider; The subscriber account includes a set of `prepaid accounts` with balances, a set of information about of `external (postpaid) accounts` and a set of `credit limit balances` which are debited when the customer uses services or credited when he makes refills.
SubscriberAccountSearchFilterModel	This filter allows to retrieve any subscriber account by using `attributeDescription` to build search criterias.
SubscriberData	This class represents a container for master data related to subscribers (end customers of a service provider) stored in an SAP CC system; It can be used to `export` or `import` this customer master data for data transport or data migration purpose.
SubscriptionContextModel	This `Java class` represents a subscription context.
SubscriptionCounterSnapshotModel	This class represents a set of `counter snapshots` recorded for a `subscription`.
SubscriptionModel	This `Java class` represents a subscription in customer master data owned by a service provider; A subscription represents a business agreement between an end customer and the service provider.
SubscriptionModificationModel	This class represents a subscription modification model by using `attributeModificationModel` to describe each modification.
SubscriptionSearchFilterModel	This class represents the subscription filter.
SubscriptionSnapshotHolderModel	This class represents either the root `subscription` or a sub-subscription inside a `counter snapshot`, and contains the list of included `counters`.
SynchronizeExternalCurrenciesOp	This operation allows to synchronize the currencies define by the ExportableItem Integration Framework (EIF).
SynchronizeExternalCurrenciesResult	An external currencies synchronize result is the result of the external currencies synchronize operation.
TaxParameter
TaxParameterModel	This class improves the `TaxParameter` adding XML marshalling.
TaxParameterSet<T extends TaxParameter>
TaxParameterSetModel	This class represents the tax settings (formed by a set of `tax parameters`) of a `charge condition` customized in an offer.
TierTableInstanceModel	This class represents a tier table instance.
TierTableInstanceSetModel	A tier table instances set model represents a set of cohesive tier table instances.
TierTableModel	This `Java class` represents a tier table as seen when it comes from the back-end database; It is part of the master data owned by a service provider.
TierTableOutAttributeModel	This class represents an output attribute in a tier table and contains a name, a type, a description and a calculation mode.
TierTableRowModel	This class represents a row in a tier table.
TierTableSearchFilterModel	This filter allows to retrieve any tier table by using `attributeDescriptionModel` to build search criterias.
TransactionTemplateModel	A `TransactionTemplateModel` represents the required fields of the computed transactions.
TranslateValueOp	This operation allows to request for the interrogation of a translation table instance from a set of input values and returns corresponding output values.
TranslateValueResult	This result class provides the asked translated value.
TranslationInstanceModel	This class represents a translation table instance.
TranslationInstanceSetModel	A translation instances set model represents a set of cohesive translation instances.
TranslationRowModel	This class represents a row in a translation table.
TranslationTableModel	This `Java class` represents a translation table as seen when it comes from the back-end database system.
TranslationTableSearchFilterModel	This filter allows to retrieve any translation table by using `attributeDescriptionModel` to build search criterias.
UniqueIdentifier	This object represents a unique identifier with a type and a value.
UnlockChargingContractOp	This operation gives the possibility to unlock a given provider contract, previously locked because of a bulk rerating operation.
UnlockChargingContractResult	An unlock provider contract result indicates that the targeted provider contract has been correctly unlocked.
UnlockSubscriptionOp	This operation allows to unlock a `subscription` in customer master data of a service provider.
UnlockSubscriptionResult	An unlock subscription result indicates that targeted subscription has been correctly unlocked.
UpdateRateResult	The result of a `UpdateRateOp` operation.
UsageChargeModel	This class represents a usage charge of a charging plan.
UsageRateModel	This class represents an usage rate.

Enum Summary
Enum	Description
AccessibleChargeType	This `enumeration` lists the types of an `accessible charge` in customer master data: `AccessibleChargeType.SUBSCRIPTION` or `AccessibleChargeType.CHARGING_CONTRACT`.
AccountOperation.AccountOperationType	This enumeration lists the possible types for an account operation.
AccountOperation.AccountReferenceType	This enumeration lists the possible types for an account reference.
AccountState	This `enumeration` lists the account states; They must be one among the four next, given in ascending order, from initial state to terminal state.
AccountType	This `enumeration` lists all the types of an account in a subscriber account.
AcquisitionException.AcquisitionExceptionReason	This `enumeration` defines the possible reasons for the `failure` of a direct acquisition operation of chargeable items.
ChargedItemMapping.ReportingScope	This enumeration contains the possible configurations for the reporting scope used during charged items aggregation.
ChargingMode	This `enumeration` lists the charging modes: `ChargingMode.forceNothing`, `ChargingMode.forceCreditLimitBalancesOnly`, or `ChargingMode.forceAll`.
ChargingPlanAccountType	Enumeration specifying the type of an account. An account can be `postpaid` or `prepaid`.
DetailCategory
DistributedCounterOperationType	This is enumeration of the operation type of a distributed counter.
ExportableItemTemplateType	This class specifies the type of an exportable item template.
ExportableProperty
ExportableProperty.Level
ExportSubscriberDataOp.ExportSubscriberDataType	This enumeration represents the types of exportable objects.
ExternalAccountModel.ExternalAccountType
InvalidAccountInitializationException.InvalidAccountInitializationType
InvalidSubscriberDataExportErrorException.InvalidSubscriberDataExportCategory	This enumeration represents the categories of errors which can occur when exporting `subscriber data`.
InvalidSubscriberDataImportErrorException.InvalidSubscriberDataImportCategory	This enumeration represents the categories of errors which can occur when importing `subscriber data`.
ISessionOperationItemResult.SessionOperationItemResultStatus	The result status.
ISessionOperationItemResult.SessionOperationItemResultType	The type of the `ISessionOperationItemResult`.
ParameterAdditionalInfoHelper.ParameterAdditionalInfoDataType
PrepaidTransactionField	This enumeration represents the different prepaid transactions transaction fields that can be mapped to a prepaid transaction.
RateComponentType	This `enumeration` lists the types of the logic components in price plans, charging plans, refill logic, and allowance logic.
RateComponentType.RateComponentCategory	This enumeration lists the possible categories of a rate component.
RateComponentType.RateComponentLocation	This enumeration lists the possible locations of a rate component.
RatingContextDescription.AllowanceFlag	The allowance flag defined if the charge component is an allowance component, a shared allowance component or not an allowance.
RefillPrepaidAccountOp.EmptyingType
ReratingStatus	This `enumeration` lists the rerating statuses.
SearchCodeResult.ModelCompatibility
SessionOperationException.SessionOperationErrorCategory	This `enumeration` provides the possible error reasons and categories that must be managed when handling a `session operation exceptions`: `SessionOperationException.SessionOperationErrorCategory.SESSION_ALREADY_EXISTS` or `SessionOperationException.SessionOperationErrorCategory.SESSION_DOES_NOT_EXIST`.
SubscriberAccountModel.DefaultChargedAccountType
SubscriptionModel.SubscriptionType
TaxParameterSet.TaxModule
TierTableOutAttributeModel.ComputationMode

Exception Summary
Exception	Description
AcquisitionException	Exception thrown to your client application when a direct batch acquisition operation of a `collection of chargeable items` fails in the connected SAP CC Core Server system; Batch acquisition is an operation available in the Offline Charging Services (OFCS) provided by SAP Convergent Charging.
ActivateException	Exception thrown when the activation operation is requested with invalid arguments.
BatchChargeException	Exception thrown to your client application when a batch charging operation of a `collection of chargeable items` fails in the connected SAP CC Core Server system; Batch charging is an operation available in the Offline Charging Services (OFCS) provided by SAP Convergent Charging.
CannotInverseException	Exception thrown when a rate cannot be inversed.
CleanupException	Exception thrown during the processing of a cleanup operation request in the connected SAP CC system; The exception is registered in the `operation results`.
DefaultHCIException	This class must be extended by all the operation failure exceptions.
DisabledFeatureException
ExportableItemConnectorException	Exception thrown when the EIF cannot be initialized.
ExportableItemMappingException	Generic exception thrown when there is an error during exportable item mapping manipulation.
ForbiddenChargeException	Exception thrown when the charging or refilling process is forbidden; For example, this occurs when there is no `service access information`, when agreement (contract, `subscription`) is not valid any longer, when the price plan forbids charging, or when arguments are not correct.
ForbiddenChargingProcessException	Exception thrown when the charging process is forbidden; This occurs when there is no access, when agreement is not valid any longer, when the price plan forbids charging or when arguments are not correct.
InvalidAccountInitializationException
InvalidItemException	Exception thrown when the rating and charging context is invalid in the connected SAP CC system when processing a business operation.
InvalidSubscriberAccountException	Generic exception thrown when an object is invalid: a subscriber account, its settings or its included objects (prepaid account, credit limit balance).
InvalidSubscriberDataExportErrorException	Generic exception thrown when there is an attempt to export something which is not valid.
InvalidSubscriberDataImportErrorException	Generic exception thrown when there is an attempt to import something which is not valid.
PostRateException	Exception that may occur during a `PostRateOp` execution.
PreRateException	Exception that may occur during a `PreRateOp` execution.
PurgeAllowanceException	Exception thrown when the purge allowance operation is requested with invalid arguments.
RerateBulkException	Exception thrown when a rerating operation fails in the SAP CC system.
SessionOperationException	Exception thrown when a session-based charging operation failed by charging session control; Your `customized charging client` should handle these types of exceptions internally.
StartRateException	Exception for the `StartRateOp` operation fails during session-based charging.
StatelessContextSerializationException	Exception thrown by the `StatelessContextSerializer` when errors occur.
StatelessPreRatingException
StatelessRateException	Exception thrown when a `rating operation request` fails in the connected SAP CC system.
StopRateException	The exception for the `StopRateOp` operation.
TransactionClearingException	Exception thrown when an error occurs during the clearing of a business transaction.
UnlockChargingContractException	Exception thrown when the unlocking of a provider contract fails.
UnlockSubscriptionException	Exception thrown when the unlocking of a `subscription` fails.
UpdateRateException	Exception thrown when the `Update Rate operation` failed due to several possible reasons.

Package com.highdeal.pnr.hci Description

This Java package provides you with all the necessary Java classes for managing the master data of a service provider: elements of the pricing catalogs, master data related to the end customers who consume the marketable service; This master data allows you to configure the pricing and charging of customer services.

Note

This Java package is part of the HCI technical interface provided by SAP Convergent Charging. See the main com.highdeal.hci package for more information.

Technical Interface	HCI (HTTP Communication Interface)
Communication Protocol	XML over HTTP (or HTTPS)
Communication Mode	Asynchronous, synchronous
Public Endpoints	Dispatcher instances of the SAP CC system (Each dispatcher instance has a communication port relating to the HTTP communications)
API Technology	[x] Java [ ] SOAP [x] Proprietary XML
SAP CC Java Library	`core-client.jar`
Security	Yes (see the SAP CC Security Guide)

Business Services

Note

Make sure that you are aware of the concepts of SAP Convergent Charging. Consider the SAP CC Application Help.

Implementation in Your Client Application

Java APIs

Consider the classes in this package.

Communications

You use the HTTP Communication Interface (HCI) technical interface provided by SAP Convergent Charging to communicate with the updater instances of the connected SAP CC Core Server system.

Consider the com.highdeal.hci package to implement the management of message exchange. Implement a message sender by using the specialized factory API.

Error Handling

Consider the exceptions depending on the service operations expected by your business requirements. Design and develop the appropriate exception handling.

Notes on Implementation

Web Services

SAP SE recommends for new implementation projects, that you use the Web Services technical interface. This modern interface allows you to configure the master data and to implement the business services expected by your business requirements.

Examples

You can use the SAP CC Core Tool user interface to view the HCI communications that result from the creation or maintenance of a master data.

Additional Information

Consult the SAP CC Application Help for more information about this master data and the related features and processes (catalog management, data provisioning).

Consult the Web Services Documentation for more implementation information of this modern technical interface.