SAP CC 1.0
API 4.2 (Core)

Package com.highdeal.pnr.hci

Provides the Price'nRate JAVA / XML APIs.

See:
          Description

Interface Summary
BatchChargeResult.BatchChargeResultHandler  
ContextualNode RESERVED FOR INTERNAL USE.
ForbiddenChargeListener  
RatingContextDescription RESERVED FOR INTERNAL USE.
SharedObjectsRetriever RESERVED FOR INTERNAL USE.
StatelessPostRateResult Object which is returned to the client application from the stateless post-rate.
StatelessPreRateResult Object which is returned to the client application from the stateless pre-rate.
SubscriberAccountVisitor  
 

Class Summary
AccessibleChargeModel This class represents an accessible charge.
AccessInSubsReflect This class represents a way to encode/decode an access in a subscription reflect.
AccessModel This class represents an identification of a service, and of a user of this service in an Operations Support System (OSS).
AccessSearchFilterModel This class represents the Access filter.
AdditionalInfoModel This class represents an additional information.
AmountAlertModel This class represents an alert which must be triggered when the balance reaches a certain amount.
BatchChargeResult Result of the batch charge operation.
BatchRatingGroupModel Transactive may handle batch and real time at the same time.
ChargeableItem This class represents the chargeable item that is sent by client applications to perform the charge process.
ChargeableItemDescriptionModel This class represents the scheme of a chargeable item that is added to a product description.
ChargeActivationModel A ChargeActivationModel represents a charge activation.
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 A ChargeComponentModel represents a full charge component.
ChargeConditionModel A ChargeConditionModel represents the information to build a new charge condition.
ChargeDependencyModel This class represents a dependency between two charges.
ChargeDependencySetModel A charge dependencies set model represents a set of cohesive charge dependencies.
ChargeModel This class is the root class for the different charging classes.
ChargeParameters This class represents the parameters of a charge operation The chargeable item that is sent during this operation must contain consumption date.
ChargingMappingModel A ChargingMappingModel represents a charging mapping.
ChargingPlanDictionaryModel This class represents the dictionary for all the charging plans of the charge component.
ChargingPlanModel This class represents a charging plan.
CheckLimitResult Object that is returned by a check limit.
CleanupResult This class implements the result for CleanupOp operation.
ClearPrepaidAccountOp This operation clears a prepaid account.
ClearPrepaidAccountResult This class conveys the result of ClearPrepaidAccountOp operation.
ComponentProperty Helper class to marshall and unmarshall rating components.
CounterDescriptionModel This class represents a counter description.
CounterModel This class represents a counter in a business relationship.
CreateAccessOp This operation allows to create a new access.
CreateAccessResult A create access result gives the access that has been created.
CreateBatchRatingGroupOp This operation must be used for the creation of a new batch rating group.
CreateBatchRatingGroupResult This result is sent back when associated @link BatchRatingGroupModel batch rating group} creation was successful.
CreateChargeComponentOp This operation allows 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.
CreateOfferOp This operation allows to create a new offer.
CreateOfferResult A create offer result gives the code and the reference of the offer that has been created.
CreatePricingMacroOp This operation class represents the creation of a new pricing macro.
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 Creates a persistent subscriber account.
CreateSubscriberAccountResult This class conveys the result of CreateSubscriberAccountOp operation.
CreateSubscriptionOp This operation allows to create a new subscription.
CreateSubscriptionResult A create subscription result gives the reference and the code of the subscription that has been created.
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 class represents a credit limit balance.
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 is the reason of the exception.
DeleteAccessBulkOp This operation allows to do a bulk deletion of accesses thanks to a filter selecting entities to be deleted.
DeleteAccessBulkResult The delete access bulk result returns the number of deleted accesses.
DeleteAccessOp This operation class represents the deletion of an access.
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 @link BatchRatingGroupModel batch rating group} deletion was successful.
DeleteChargeComponentOp This operation class represents the deletion of a charge component.
DeleteChargeComponentResult The delete charge component result returns the code of the deleted charge component.
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 conveys the result of DeleteSubscriberAccountOp 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.
DeleteSubscriptionResult The delete subscription result returns the code of the deleted subscription.
DeleteTranslationTableOp This operation class represents the deletion of a translation table.
DeleteTranslationTableResult The delete translation table result returns the code of the deleted translation table.
DetailTemplateModel This class represents a detail template.
ExpirationAlertModel This class represents an alert which must be triggered before or after a reference date when a prepaid account state as changed.
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.
ExportSubscriberSubsDataResult This class represents the result of the export operation.
ExternalAccountModel This class represents an external account of a subscriber account.
ExternalChargeActionModel This class represents the action of charging on an external charging reference.
GetSubAccountSubscriptionCodesOp This operation allows to retrieve a list of subscription codes for a given subscriber account.
GetSubAccountSubscriptionCodesResult This class conveys the result of GetSubAccountSubscriptionCodesOp operation.
ImportOp This operation allows to import a pnr object set.
ImportResult An import result is the result of the import 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  
MacroComponentModel This abstract class represents a rate component that runs a pricing macro.
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 @link BatchRatingGroupModel 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.
ModifyOfferOp This operation allows to modify an existing offer.
ModifyOfferResult The modify offer result conveys the code and/or the reference of the modified offer.
ModifyPricingMacroOp This operation class represents the modification of a pricing macro.
ModifyPricingMacroResult The modifiy pricing macro result conveys the code and/or the reference of the modified pricing macro.
ModifyProductOp This operation class represents the modification of a product.
ModifyProductResult The modify product conveys the code and/or the reference of the modified product.
ModifySubscriberAccountOp This operation modifies a subscriber account.
The modification of a subscriber account is taken into account immediatly.
ModifySubscriberAccountResult This class conveys the result of ModifySubscriberAccountOp 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 a subscription.
ModifySubscriptionResult The modify subscription result conveys the code and/or the reference of the modified subscription.
ModifyTranslationTableOp This operation class represents the modification of a translation table.
ModifyTranslationTableResult The modify translation table result conveys the code and/or the reference of the modified translation table.
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 class represents an offer model.
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.
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.
ParameterModel This class represents the description of a parameter.
ParameterSetModel A parameters set model represents a set of cohesive parameters.
PnRObjectSet This class represents a pnr object set.
PnRXMLMapping Defines the mapping between XML tags and marshallable classes.
PostRateResult The result of a PostRateOp 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 class represents a prepaid account of a subscriber account.
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.
PricePlanModel This class represents a price plan model.
PricingMacroModel This class represents an existing pricing macro.
ProductModel This class represents a product that corresponds to something that can be charged.
Property This class represents a chargeable item property.
PropertyDescriptionModel This class represents the description of a property as seen by a client application.
PropertyEntryModel This class represents a property entry.
ProrataModel This class represents a prorata.
PurchaseOrder Object which is returned to the client application from the charge processes (service and duration).
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 RESERVED FOR INTERNAL USE.
RecurringChargeModel This class represents a recurring charge of a charging plan.
RecurringDateModel This class implements recurring rate.
RecurringRateModel This class represents a recurring rate.
ReferenceStateDate This class represents an enumeration of possible state for expiration alerts.
RefillChargeActionModel This class represents the action of refill.
RefillPrepaidAccountOp This operation has to be alone in an envelope or with others RefillPrepaidAccountOp or ClearPropaidAccountOp.
RefillPrepaidAccountResult This class conveys the result of RefillPrepaidAccountOp operation.
RerateBulkOp This class represents the rerating operation as a bulk operation.
RerateBulkResult This class conveys the result of the rerate bulk operation.
ResetCreditLimitBalanceOp Resets the credit limit balance.
ResetCreditLimitBalanceResult This class conveys the result of ResetCreditLimitBalanceOp operation.
SearchAccessFromSubscriptionOp This operation allows to retrieve accesses which link a subscription or a charge activation.
SearchAccessFromSubscriptionResult This class conveys the result of searchAccess operation.
SearchAccessOp The search access allows to retrieve any access by using a AccessSearchFilterModel to build search criterias.
SearchAccessResult This class conveys the result of searchAccess operation.
SearchAllBatchRatingGroupsOp This operation must be used for retrieving all the batch rating group that are defined.
SearchAllBatchRatingGroupsResult This class conveys the result of batch rating group 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.
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.
SearchCodeOp This operation class searches an object giving its type and optionally its owner and return an object code list.
SearchCodeResult This class represents the result of the search code 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 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.
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 Retrieves one or more subscriber account according to criteria of the given search filter.
SearchSubscriberAccountResult This class conveys the result of SearchSubscriberAccountOp operation.
SearchSubscriptionFromAccessOp The search subscription allows to retrieve any subscription from an access selection by using a AccessSearchFilterModel to build search criterias.
SearchSubscriptionFromAccessResult This class conveys the result of searchSubscriptionFromAccess operation.
SearchSubscriptionOp This operation allows to retrieve subscriptions.
SearchSubscriptionResult This class represents the result of the search subscription operation.
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.
StartRateResult The result of a StartRateOp operation.
StatelessContextSerializer This class provides methods for serialization and unserialization of 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 class represents the stateless rating context.
StatelessRatingEvent This class represents the stateless rating event.
StopRateResult The result of a StopRateOp operation.
SubscriberAccountModel A subscriber account represents a set of subscription belonging to a subscriber.
SubscriberAccountSearchFilterModel This filter allows to retrieve any subscriber account by using attributeDescription to build search criterias.
SubscriptionContextModel A SubscriptionContextModel represents a subscription context.

If a subscription redefines the dependencies between its charge activations, its subscription context will contain a set of charge dependencies.
SubscriptionModel This class represents a subscription model, which is an offer that is subscribed to by a customer as part of a contract.
SubscriptionModificationModel This class represents a subscription modification model by using attributeModificationModel to describe each modification.
SubscriptionReflectMappingModel A SubsReflectMappingModel represents the subscription required fields to export.
SubscriptionSearchFilterModel This class represents the subscription filter.
TaxRateConstants This class defines constants for Tax rate usage.
TransactionTemplateModel A TransactionTemplateModel represents the required fields of the transactions.
TranslateValueOp This operation class represents 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 class represents the translation table model as seen when it comes from the database.
TranslationTableSearchFilterModel This filter allows to retrieve any translation table by using attributeDescriptionModel to build search criterias.
UnlockSubscriptionOp This operation allows to unlock a subscription.
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
AccountState The account state must be one among the four next, given in ascending order, from initial state to terminal state.
ChargingMode  
DetailCategory  
ExportableProperty  
ExportableProperty.Level  
ExternalAccountModel.ExternalAccountType  
PrepaidTransactionField This enumeration represents the different prepaid transactions transaction fields that can be mapped to a prepaid transaction.
RateComponentType The class represents the type of the rate component.
RateComponentType.RateComponentCategory Categories of a rate component: root: the first rate component of the tree. intermediate: the intermediate (not a root and not a leaf) rate component of the tree. leaf: the last rate component of the tree. notAuthorized: rate component not authorized in the tree.
RefillChargeActionModel.BeforeRefill This class represents the action before the refill.
RefillPrepaidAccountOp.EmptyingType  
SubscriberAccountModel.DefaultChargedAccountType  
SubscriptionModel.ReratingStatus  
SubscriptionModel.SubscriptionType  
 

Exception Summary
ActivateException Exception thrown when the activation operation is invoked with invalid arguments.
BatchChargeException Exception thrown when an error occurs during a multiple charge.
CannotInverseException Exception thrown when a rate cannot be inversed.
CleanupException Exception that may be thrown during CleanupOp execution.
DefaultHCIException This class must be extended by all the operation failure exception.
DisabledFeatureException  
ForbiddenChargeException Exception thrown when the charge process is forbidden.
InvalidItemException Exception thrown when the rating context is invalid.
InvalidSubscriberAccountException  
PostRateException Exception that may occur during a PostRateOp execution.
PreRateException Exception that may occur during a PreRateOp execution.
RerateBulkException This exception is thrown when rerating fails.
StartRateException The exception for the StartRateOp operation.
StatelessContextSerializationException This Exception is used by the StatelessContextSerializer when errors occur.
StatelessPreRatingException  
StatelessRateException Exception thrown when the rate stateless fails.
StopRateException The exception for the StopRateOp operation.
TransactionClearingException Exception thrown when the charge process cannot clear the transaction.
UnlockSubscriptionException Exception thrown when unlock subscription fails.
UpdateRateException The exception for the UpdateRateOp operation.
 

Package com.highdeal.pnr.hci Description

Provides the Price'nRate JAVA / XML APIs.


SAP CC 1.0
API 4.2 (Core)


API Reference - July 2009

SAP Convergent Charging 1.0 (build R4.2.1.35.0.0)
CONVERGENT CHARGING 4.2

(c) Copyright 2009 SAP AG. All rights reserved.