com.highdeal.cnd.message
Interface ISessionReservation

All Known Subinterfaces:

ISessionStartChargingAsyncOperation, ISessionStartChargingOperation, ISessionUpdateChargingAsyncOperation, ISessionUpdateChargingOperation

All Known Implementing Classes:

SessionChargingOperation

public interface ISessionReservation

This Java interface defines the key prepareReserve(..) method necessary for managing a reservation during session-based charging.

Implementation in Your Client Application

The prepareReserve(..) method is available in the following container operations:

Async. comm.	Sync. comm.
createSessionStartAsyncOperation(..)	createSessionStartOperation(..)
createSessionUpdateAsyncOperation(..)	createSessionUpdateOperation(..)

Note

Consider the following interfaces to implement in your integration code:

• the ISessionConfirmation interface for more information about the reservation confirmation or reservation cancellation.
• the ISessionConfirmAndReserve interface for more information about the reservation extension.

Do not use the SessionChargingOperation Java class to develop your Java-based client application.

See Also:

ISessionConfirmation (about reservation confirmation or reservation cancellation), ISessionConfirmAndReserve(about reservation extension)

Nested Class Summary

static class

ISessionReservation.SessionReservationResolution This enumeration lists the resolutions of a session reservation: confirmed of canceled.

Method Summary

void	prepareReserve(java.lang.String reservationId, ChargeableItem reservationItem, ISessionReservation.SessionReservationResolution defaultResolution, long ttl, java.lang.String propertyToInverse) This method allows you to create a reservation request during session-based charging operations.

Method Detail

prepareReserve

void prepareReserve(java.lang.String reservationId,
                    ChargeableItem reservationItem,
                    ISessionReservation.SessionReservationResolution defaultResolution,
                    long ttl,
                    java.lang.String propertyToInverse)

This method allows you to create a reservation request during session-based charging operations.

It triggers in the connected SAP CC system, the rating (dynamic pricing) and reservation of the specified chargeable item by performing the related counter reservations.

Note

If the reservation fails due to a low-credit, an inverse rating may be attempted if the property name of the property to inverse is specified. This mechanism is known as best effort reservation. This property name is saved in the charging session to avoid providing it again or changing it at update.

Options: You use the parameters ttl and defaultResolution to set up an automated processing (reservation confirmation or reservation cancellation), when the time to live (TTL) has expired. The SAP CC system manages the last counter or balance reservations accordingly.

Parameters:

reservationId - The reservation identifier that must be unique within a session

reservationItem - The mandatory chargeable item that includes the service consumption information

defaultResolution - The default resolution of the rating session at expiration time (ISessionReservation.SessionReservationResolution.CANCELLED or ISessionReservation.SessionReservationResolution.CONFIRMED)

ttl - The time to live (TTL) expressed in seconds

propertyToInverse - The name of the property in the reservationItem to inverse in case of best effort reservation