com.highdeal.pnr.hci

Class ForbiddenChargeException

java.lang.Object

java.lang.Throwable

java.lang.Exception

com.highdeal.hci.OperationFailureException

com.highdeal.pnr.hci.ForbiddenChargeException

All Implemented Interfaces:

OperationResult, XMLMarshallable, IChargingResultHolderException, java.io.Serializable

public class ForbiddenChargeException
extends OperationFailureException
implements IChargingResultHolderException

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.

Important Notes

• This exception is specified in HCI but it is also available in the Message TCP technical interface. See the Exception and Error Handling section of this technical interface.

  For example, if your client application requests a charging operation in real time, the SAP CC system may reply this forbidden charge exception.

• In an offline charging scenario, the SAP CC system may include this exception in the BatchChargeException or RerateSubscriptionException as the cause.

Reasons

The possible reasons are:

Failure	Reason Code	Reason Code (HCI)	Customizing and Integration	Troubleshooting (Next Steps)
No access information found	0	noAccessFound	Note To design the exception and error handling functions (automated treatments, logging and manual treatments), see the Field Detail section in this topic. Refer to the information available in the Customizing subsection of each failure.	Note For troubleshooting investigations, see the Field Detail section in this topic. Refer to the information available in the Next Steps subsection of each failure.
Out of validity period	1	outOfValidityPeriod
Not authorized	2	notAuthorized
Illegal argument	3	illegalArgument
Prerating not resolved yet	4	preRatingNotResolvedYet
Incompatible currencies	5	incompatibleCurrencies
Overrun cycle detected	6	overrunCycleDetected
Cannot charge account	7	cannotChargeAccount
Account blocked	8	accountBlocked
Account locked	9	accountLocked
Account closed	10	accountClosed
Pending session not stopped yet	13	pendingSessionNotStoppedYet
No subscription found	14	noSubscriptionFound
Calculate tax error	15	calculateTaxError
Invalid account (deprecated and now revoked)	16	invalidAccount
Refill refused	17	refillRefused

Consider the detailed information in the Field Detail section in this topic.

Implementation in Your Client Application

Exception and Error Handling

Depending on your business requirements, design and develop the handling functions in your client application.

Example

For example, you can implement the recording of the received exception in log entries in your client application or system. The administrator of this customized application (or system) can then investigate, perform some troubleshooting operations, and schedule an action plan to correct the potential anomaly.

See Also:

ForbiddenChargingProcessException, InvalidTaxException, Serialized Form

XML API for HCI

The XML APIs specify the following XSD fragment:

XSD Fragment

<xs:element name="forbiddenChargeFault">
   <xs:complexType>
    <xs:attribute name="error" type="ForbiddenChargeFaultErrorType"/>
    <xs:attribute name="message" type="xs:string"/>
    <xs:attribute name="reason" type="xs:string" use="optional"/>
   </xs:complexType>
  </xs:element>
 <xs:simpleType name="ForbiddenChargeFaultErrorType">
   <xs:restriction base="xs:string">
      <xs:enumeration value="noAccessFound"/>
      <xs:enumeration value="outOfValidityPeriod"/>
      <xs:enumeration value="notAuthorized"/>
      <xs:enumeration value="illegalArgument"/>
      <xs:enumeration value="preRatingNotResolvedYet"/>
      <xs:enumeration value="incompatibleCurrencies"/>
      <xs:enumeration value="overrunCycleDetected"/>
      <xs:enumeration value="cannotChargeAccount"/>
      <xs:enumeration value="accountBlocked"/>
      <xs:enumeration value="accountLocked"/>
      <xs:enumeration value="accountClosed"/>
      <xs:enumeration value="pendingSessionNotStoppedYet"/>
      <xs:enumeration value="noSubscriptionFound"/>
      <xs:enumeration value="calculateTaxError"/>
      <xs:enumeration value="invalidAccount"/>  <!-- deprecated -->
      <xs:enumeration value="refillRefused"/>
   </xs:restriction>
 </xs:simpleType>

Field Summary

Fields

Modifier and Type	Field and Description
static int	ACCOUNT_BLOCKED 8: Error when the operation fails because the prepaid account is blocked.
static int	ACCOUNT_CLOSED 10: Error when the operation fails because the prepaid account is closed.
static int	ACCOUNT_LOCKED 9: Error when the operation fails because the prepaid account is locked in the subscriber account.
static int	CALCULATE_TAX_ERROR 15: Error when tax calculation fails; Originated from an InvalidTaxException.
static int	CANNOT_CHARGE_ACCOUNT 7: Error when the operation fails because the prepaid account or the credit limit balance has an amount smaller than the amount to be charged.
static int	ILLEGAL_ARGUMENT 3: Error when the operation is called with illegal arguments.
static int	INCOMPATIBLE_CURRENCIES 5: Error when the operation fails because the transaction generated by the execution of the price plan has a currency incompatible with the currency of the prepaid account or the credit limit balance to be charged.
static int	INVALID_ACCOUNT Deprecated. Revoked: the value 16 and this field label (INVALID_ACCOUNT) are not used anymore.
static int	NO_ACCESS_FOUND 0: Error when the user technical identifier (USID) provided in the chargeable item, for the specified service (SID), does not correspond to an existing contract (or subscription) in customer master data owned by the service provider.
static int	NO_SUBSCRIPTION_FOUND 14: Error when no subscription can be found for a chargeable item.
static int	NOT_AUTHORIZED 2: Error when the execution of a price plan does not authorize access for a chargeable item.
static int	OUT_OF_VALIDITY_PERIOD 1: Error when the service consumption date of the incoming chargeable item does not correspond to a period when the identified contract (or subscription) can be charged for the digital service.
static int	OVERRUN_CYCLE_DETECTED 6: Error when the operation fails because a cycle has been detected during an overrun between prepaid account.
static int	PRERATING_NOT_RESOLVED_YET 4: Error when the operation fails because it should corrupt the rating records history of a subscription.
static int	REFILL_REFUSED 17: Error when refilling a prepaid account from another one.
static int	SESSION_NOT_STOPPED_YET 13: Error when the operation fails because it should corrupt balance and/or counters because simultaneous prerating and session-based charging on the same subscriber account.

Constructor Summary

Constructors

Constructor and Description
ForbiddenChargeException() Builds an empty forbidden charge exception.
ForbiddenChargeException(ForbiddenChargingProcessException fcpe) Builds an empty forbidden charge exception.
ForbiddenChargeException(int error, java.lang.String message) Constructs an exception with a message and an error that explain why the charging is forbidden.
ForbiddenChargeException(int error, java.lang.String message, ChargingResult chargingResult) Constructs an exception with a message and an error that explain why the charging is forbidden.
ForbiddenChargeException(int error, java.lang.String message, java.lang.String reason) Constructs an exception with a message and an error and a sub message and a sub error that explain why the charging is forbidden.
ForbiddenChargeException(int error, java.lang.String message, java.lang.String reason, ChargingResult chargingResult) Constructs an exception with a cause, a message and an error that explain why the charging is forbidden.

Method Summary

Modifier and Type	Method and Description
void	addCharacterData(java.lang.String cData) Adds character data to the content element.
void	addChild(java.lang.String tagName, XMLMarshallable child) Adds a child to the object, the child representing the marshallable object which must be added to the element.
static void	asyncThrow(int reason, java.lang.String msg, ForbiddenChargeListener listener)
ChargingResult	getChargingResult() Returns the ChargingResult that provides structured information about the exception.
int	getError() Returns the error that forbids the charging/refilling process.
java.lang.String	getMessage() Returns the detailed message explaining why charging is forbidden.
java.lang.String	getReason() Returns the reason that forbids the charging process.
void	marshal(XMLOutputter output) Gives an XML representation of this object, including its children.
void	setAttributes(XMLAttributes atts) Sets the attributes of the XML representation of the element being processed.

Methods inherited from class com.highdeal.hci.OperationFailureException

getOperandReference

Methods inherited from class java.lang.Throwable

addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

NO_ACCESS_FOUND

public static final int NO_ACCESS_FOUND

0: Error when the user technical identifier (USID) provided in the chargeable item, for the specified service (SID), does not correspond to an existing contract (or subscription) in customer master data owned by the service provider.

Next Steps

To solve this issue:

• Verify the logs in your client application (mediation system, ohter) to get the access identifiers missing in SAP CC.
• Check SAP CRM fulfillment logs to see if there is any error during provider contract replication.
• Correct the issue and replicate the correct provider contract.

See Also:

Constant Field Values

OUT_OF_VALIDITY_PERIOD

public static final int OUT_OF_VALIDITY_PERIOD

1: Error when the service consumption date of the incoming chargeable item does not correspond to a period when the identified contract (or subscription) can be charged for the digital service.

Detailed Information

This error happens when end customers are not allowed to use the digital service for the consumption date set in the chargeable item. This error is a business error and should not be retried.

Next Steps

Do not implement an automated treatment.

To solve this issue:

• Verify the logs in your client application (mediation system, ohter) to get the access identifiers and search for the corresponding provider contract.
• Use SAP CRM to cancel the corresponding contract item and create a new one with correct validity dates.

See Also:

Constant Field Values

NOT_AUTHORIZED

public static final int NOT_AUTHORIZED

2: Error when the execution of a price plan does not authorize access for a chargeable item.

See Also:

Constant Field Values

ILLEGAL_ARGUMENT

public static final int ILLEGAL_ARGUMENT

3: Error when the operation is called with illegal arguments.

See Also:

Constant Field Values

PRERATING_NOT_RESOLVED_YET

public static final int PRERATING_NOT_RESOLVED_YET

4: Error when the operation fails because it should corrupt the rating records history of a subscription. This error occurs only when attempting to rerate or to reserve using a subscription that has preratings that are not resolved yet.

See Also:

Constant Field Values

INCOMPATIBLE_CURRENCIES

public static final int INCOMPATIBLE_CURRENCIES

5: Error when the operation fails because the transaction generated by the execution of the price plan has a currency incompatible with the currency of the prepaid account or the credit limit balance to be charged.

See Also:

Constant Field Values

OVERRUN_CYCLE_DETECTED

public static final int OVERRUN_CYCLE_DETECTED

6: Error when the operation fails because a cycle has been detected during an overrun between prepaid account.

See Also:

Constant Field Values

CANNOT_CHARGE_ACCOUNT

public static final int CANNOT_CHARGE_ACCOUNT

7: Error when the operation fails because the prepaid account or the credit limit balance has an amount smaller than the amount to be charged.

See Also:

Constant Field Values

ACCOUNT_BLOCKED

public static final int ACCOUNT_BLOCKED

8: Error when the operation fails because the prepaid account is blocked.

See Also:

Constant Field Values

ACCOUNT_LOCKED

public static final int ACCOUNT_LOCKED

9: Error when the operation fails because the prepaid account is locked in the subscriber account.

See Also:

Constant Field Values

ACCOUNT_CLOSED

public static final int ACCOUNT_CLOSED

10: Error when the operation fails because the prepaid account is closed.

See Also:

Constant Field Values

SESSION_NOT_STOPPED_YET

public static final int SESSION_NOT_STOPPED_YET

13: Error when the operation fails because it should corrupt balance and/or counters because simultaneous prerating and session-based charging on the same subscriber account. This error occurs only when attempting to prerate on a subscriber account with pending session or to start a session on a subscriber account with a rating record history not empty.

Note

This constant is also used when the session cleanup fails due to a lack of session memory.

See Also:

Constant Field Values

NO_SUBSCRIPTION_FOUND

public static final int NO_SUBSCRIPTION_FOUND

14: Error when no subscription can be found for a chargeable item.

See Also:

Constant Field Values

CALCULATE_TAX_ERROR

public static final int CALCULATE_TAX_ERROR

15: Error when tax calculation fails; Originated from an InvalidTaxException.

See Also:

Constant Field Values

INVALID_ACCOUNT

@Deprecated
public static final int INVALID_ACCOUNT

Deprecated. Revoked: the value 16 and this field label (INVALID_ACCOUNT) are not used anymore.

16: Constant error when debtor or creditor identifiers are missing.

See Also:

Constant Field Values

REFILL_REFUSED

public static final int REFILL_REFUSED

17: Error when refilling a prepaid account from another one.

See Also:

Constant Field Values

Constructor Detail

ForbiddenChargeException

public ForbiddenChargeException()

Builds an empty forbidden charge exception.

ForbiddenChargeException

public ForbiddenChargeException(ForbiddenChargingProcessException fcpe)

Builds an empty forbidden charge exception.

ForbiddenChargeException

public ForbiddenChargeException(int error,
                                java.lang.String message)

Constructs an exception with a message and an error that explain why the charging is forbidden. The message contains a human readable text. It explains the reason why the charge process is forbidden.

Parameters:

error - The error code

message - The message

ForbiddenChargeException

public ForbiddenChargeException(int error,
                                java.lang.String message,
                                ChargingResult chargingResult)

Constructs an exception with a message and an error that explain why the charging is forbidden. The message contains a human readable text. It explains the reason why the charge process is forbidden.

Parameters:

error - The error code

message - The message

chargingResult - The ChargingResult which provides structured information about the exception

ForbiddenChargeException

public ForbiddenChargeException(int error,
                                java.lang.String message,
                                java.lang.String reason)

Constructs an exception with a message and an error and a sub message and a sub error that explain why the charging is forbidden. The message contains a human readable text. It explains the reason why the charge process is forbidden.

Parameters:

error - The error code

message - The message

reason - The reason

ForbiddenChargeException

public ForbiddenChargeException(int error,
                                java.lang.String message,
                                java.lang.String reason,
                                ChargingResult chargingResult)

Constructs an exception with a cause, a message and an error that explain why the charging is forbidden. The message contains a human readable text. It explains the reason why the charge process is forbidden.

Parameters:

error - The error code

message - The message

reason - The reason

chargingResult - The ChargingResult that provides structured information about the exception

Method Detail

getError

public int getError()

Returns the error that forbids the charging/refilling process.

Returns:

The numerical error code

See Also:

NO_ACCESS_FOUND, OUT_OF_VALIDITY_PERIOD, NOT_AUTHORIZED, ILLEGAL_ARGUMENT, PRERATING_NOT_RESOLVED_YET, INCOMPATIBLE_CURRENCIES, OVERRUN_CYCLE_DETECTED, CANNOT_CHARGE_ACCOUNT, ACCOUNT_BLOCKED, ACCOUNT_LOCKED, ACCOUNT_CLOSED, SESSION_NOT_STOPPED_YET, NO_SUBSCRIPTION_FOUND, CALCULATE_TAX_ERROR, INVALID_ACCOUNT (deprecated and revoked), REFILL_REFUSED

getMessage

public java.lang.String getMessage()

Returns the detailed message explaining why charging is forbidden.

Overrides:

getMessage in class java.lang.Throwable

Returns:

The detailed message explaining why charging is forbidden

getReason

public java.lang.String getReason()

Returns the reason that forbids the charging process.

Returns:

The reason that forbids the charging process

See Also:

OUT_OF_VALIDITY_PERIOD

getChargingResult

public ChargingResult getChargingResult()

Description copied from interface: IChargingResultHolderException

Returns the ChargingResult that provides structured information about the exception.

Example

The ForbiddenChargeException and InvalidItemException exceptions include such a charging result complex object.

Specified by:

getChargingResult in interface IChargingResultHolderException

Returns:

The ChargingResult that provides structured information about the exception

setAttributes

public void setAttributes(XMLAttributes atts)

Description copied from interface: XMLMarshallable

Sets the attributes of the XML representation of the element being processed.

Specified by:

setAttributes in interface XMLMarshallable

Parameters:

atts - The XML attributes of the current element

addCharacterData

public void addCharacterData(java.lang.String cData)

Description copied from interface: XMLMarshallable

Adds character data to the content element.

Specified by:

addCharacterData in interface XMLMarshallable

Parameters:

cData - The character data to be added

addChild

public void addChild(java.lang.String tagName,
                     XMLMarshallable child)

Description copied from interface: XMLMarshallable

Adds a child to the object, the child representing the marshallable object which must be added to the element.

Specified by:

addChild in interface XMLMarshallable

Parameters:

tagName - The name of tag for the child

child - The child to be added

marshal

public void marshal(XMLOutputter output)

Description copied from interface: XMLMarshallable

Gives an XML representation of this object, including its children.

Specified by:

marshal in interface XMLMarshallable

Parameters:

output - The XML output to marshal the object into

asyncThrow

public static void asyncThrow(int reason,
                              java.lang.String msg,
                              ForbiddenChargeListener listener)